Skip to content

Commit 89b3ae0

Browse files
committed
Extend docs, add link to sample implementation, update changelog
1 parent 9c722ab commit 89b3ae0

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [Unreleased]
7+
## [0.4.0]
88

99
### Added
1010
- `-pr`, `--pre-releases` parameter to explicitly enable display of pre-releases in console
@@ -49,7 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4949
### Added
5050
- Initial Release
5151

52-
[Unreleased]: https://github.com/nezhar/updatable/compare/v0.3.1...HEAD
52+
[0.4.0]: https://pypi.org/project/updatable/0.4.0/
5353
[0.3.1]: https://pypi.org/project/updatable/0.3.1/
5454
[0.3.0]: https://pypi.org/project/updatable/0.3.0/
5555
[0.2.0]: https://pypi.org/project/updatable/0.2.0/

README.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Updatable
66
.. image:: https://codecov.io/gh/nezhar/updatable/branch/master/graph/badge.svg
77
:target: https://codecov.io/gh/nezhar/updatable
88

9-
Finds packages that require updates on a python environment
9+
Updatable help you to find packages that require updates on a python environment.
1010

1111
Installation
1212
~~~~~~~~~~~~
@@ -18,6 +18,9 @@ The latest release of updatable can be installed via PyPI:
1818
pip install -U updatable
1919

2020

21+
It can be installed globally or in virtual environment, depending on where you plan to check the dependencies.
22+
If you have a ``requirements.txt`` with pinned dependencies you can pass it as an argument to check against it.
23+
2124
The project supports Python ``2.7``, ``3.4``, ``3.5``, ``3.6``, ``3.7``, ``3.8`` as well as ``pypy`` and ``pypy3``.
2225

2326

@@ -27,7 +30,11 @@ Usage
2730
The package can be used as a command line tool, so you can get a list of all
2831
packages that require updates from your current environment. You may also use
2932
the package inside of your python application, to list the packages over a REST
30-
endpoint, forward them by mail or other purpose.
33+
endpoint (see a `sample implementation here`__), forward them by mail or other purpose.
34+
35+
.. _Implementation: https://github.com/anexia-it/anexia-monitoring-django
36+
__ Implementation_
37+
3138

3239
Example:
3340
::

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ def run(self):
100100
'Programming Language :: Python :: 3.5',
101101
'Programming Language :: Python :: 3.6',
102102
'Programming Language :: Python :: 3.7',
103+
'Programming Language :: Python :: 3.8',
103104
'Programming Language :: Python :: Implementation :: CPython',
104105
'Programming Language :: Python :: Implementation :: PyPy',
105106
'Intended Audience :: Developers',

0 commit comments

Comments
 (0)