Metadata-Version: 2.1
Name: dependency-checker
Version: 0.0.2
Summary: A lightweight pythonic way to check if a package's dependencies are out of date
Home-page: https://github.com/muellerzr/dependency_checker/tree/master/
Author: Zachary Mueller
Author-email: muellerzr@gmail.com
License: Apache Software License 2.0
Keywords: pipdeptree pypi dependency
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pip
Requires-Dist: packaging
Requires-Dist: pipdeptree (==2.1.0)
Requires-Dist: pipreqs (>=0.4.11)
Provides-Extra: dev

# Dependency Checker
> A lightweight pythonic way to verify if python packages are on the latest version


## Install

`pip install dependency-checker`

## How to use

```python
from dependency_checker import get_installed_dependencies, is_latest_version
```

`dependency_checker` has two functionalities:
- Checking a python project's dependencies
- Checking if a python package is on the latest version

Each are intuitive to use, and have detailed documentation available.

To check a package's dependencies, we can use the `get_installed_dependencies` function, passing in the string name of the module:

```python
get_installed_dependencies('dependency-checker', depth_limit=1)
```




    {'packaging': '21.0', 'pip': '21.2.4', 'pipdeptree': '2.1.0'}



Generally a depth of 1 is enough to get a package's main dependencies, bar `pip`, `packaging`, and other "standard" python resources.

If we also want to include the original package, we can pass that in as a parameter:

```python
get_installed_dependencies('dependency-checker', depth_limit=1, include_self=True)
```




    {'dependency-checker': '0.0.1',
     'packaging': '21.0',
     'pip': '21.2.4',
     'pipdeptree': '2.1.0'}



There also exists `is_latest_version`, which will see if a package version is the latest available on `pypi`:

```python
is_latest_version('pipdeptree', '2.0.9')
```




    False



## Automatically Building a requirements.txt file

You can also use dependency_checker to automatically build a requirements file from the command-line. It is an extension of [pipreqs](https://github.com/bndr/pipreqs), combining both our functionalities together to give a more fine-grained and stable text file.

To read more, see the documentation [here](https://muellerzr.github.io/dependency_checker/pipreqs)


