diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index d4743fb..ebea774 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -33,7 +33,7 @@ body: attributes: label: What version of nvitop are you using? description: Run command `nvitop --version` or `python3 -m nvitop --version` in your shell and paste the output here. - placeholder: E.g., 0.11.0 + placeholder: E.g., 1.0.0 validations: required: true diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8cbad6a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,41 @@ +# Changelog + + + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +------ + +## [Unreleased] + +### Added + + + +### Changed + + + +### Fixed + + + +### Removed + + + +------ + +## [1.0.0] - 2023-02-01 + +### Added + +- The first stable release of `nvitop` by [@XuehaiPan](https://github.com/XuehaiPan). + +------ + +[Unreleased]: https://github.com/XuehaiPan/nvitop/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/XuehaiPan/nvitop/releases/tag/v1.0.0 diff --git a/README.md b/README.md index f425eb7..a5811f9 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ An interactive NVIDIA-GPU process viewer and beyond, the one-stop solution for G - [Process](#process) - [Host (inherited from psutil)](#host-inherited-from-psutil) - [Screenshots](#screenshots) +- [Changelog](#changelog) - [License](#license) - [Copyright Notice](#copyright-notice) @@ -145,7 +146,7 @@ Run `bash install-nvidia-driver.sh --help` for more information. pipx run nvitop ``` -Install from PyPI ([![PyPI](https://img.shields.io/pypi/v/nvitop?label=pypi&logo=pypi)](https://pypi.org/project/nvitop) / ![Status](https://img.shields.io/pypi/status/nvitop?label=status)): +Install from PyPI ([![PyPI](https://img.shields.io/pypi/v/nvitop?label=pypi&logo=pypi)](https://pypi.org/project/nvitop)): ```bash pip3 install --upgrade nvitop @@ -157,7 +158,7 @@ Install from conda-forge ([![conda-forge](https://img.shields.io/conda/v/conda-f conda install -c conda-forge nvitop ``` -Install the latest version from GitHub (![Commit Count](https://img.shields.io/github/commits-since/XuehaiPan/nvitop/v0.11.0)): +Install the latest version from GitHub (![Commit Count](https://img.shields.io/github/commits-since/XuehaiPan/nvitop/v1.0.0)): ```bash pip3 install git+https://github.com/XuehaiPan/nvitop.git#egg=nvitop @@ -1382,6 +1383,12 @@ Spectrum-like bar charts (with option --colorful): ------ +## Changelog + +See [CHANGELOG.md](https://github.com/XuehaiPan/nvitop/blob/HEAD/CHANGELOG.md). + +------ + ## License The source code of `nvitop` is dual-licensed by the **Apache License, Version 2.0 (Apache-2.0)** and **GNU General Public License, Version 3 (GPL-3.0)** . The `nvitop` CLI is released under the **GPL-3.0** license while the remaining part of `nvitop` is released under the **Apache-2.0** license. The license files can be found at [LICENSE](https://github.com/XuehaiPan/nvitop/blob/HEAD/LICENSE) (Apache-2.0) and [COPYING](https://github.com/XuehaiPan/nvitop/blob/HEAD/COPYING) (GPL-3.0). diff --git a/docs/source/index.rst b/docs/source/index.rst index 410e753..2c0aa70 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -25,9 +25,6 @@ An interactive NVIDIA-GPU process viewer and beyond, the one-stop solution for G .. |Conda-forge Package| image:: https://img.shields.io/conda/v/conda-forge/nvitop?logo=condaforge .. _Conda-forge Package: https://anaconda.org/conda-forge/nvitop -.. |Package Status| image:: https://img.shields.io/pypi/status/nvitop?label=status -.. _Package Status: https://pypi.org/project/nvitop - .. |Documentation Status| image:: https://img.shields.io/readthedocs/nvitop?label=docs&logo=readthedocs .. _Documentation Status: https://nvitop.readthedocs.io @@ -51,7 +48,7 @@ Installation pipx run nvitop -Install from PyPI (|PyPI Package|_ / |Package Status|_): +Install from PyPI (|PyPI Package|_): .. code:: bash @@ -83,7 +80,7 @@ Or, clone this repo and install manually: If this repo is useful to you, please star ⭐️ it to let more people know 🤗. |GitHub Repo Stars|_ -.. |Commit Count| image:: https://img.shields.io/github/commits-since/XuehaiPan/nvitop/v0.11.0 +.. |Commit Count| image:: https://img.shields.io/github/commits-since/XuehaiPan/nvitop/v1.0.0 ------ diff --git a/nvitop/version.py b/nvitop/version.py index ce9b144..63f1026 100644 --- a/nvitop/version.py +++ b/nvitop/version.py @@ -16,7 +16,7 @@ # ============================================================================== """An interactive NVIDIA-GPU process viewer and beyond, the one-stop solution for GPU process management.""" -__version__ = '0.11.0' +__version__ = '1.0.0' __license__ = 'GPLv3' __author__ = __maintainer__ = 'Xuehai Pan' __email__ = 'XuehaiPan@pku.edu.cn'