Metadata-Version: 2.1
Name: example_pkg_cloos
Version: 3.0.1
Summary: A example package to learn and test Python packaging.
Author-email: Christian Loos <cloos@netsandbox.de>
License: MIT License
        
        Copyright (c) 2019 Christian Loos
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://github.com/netsandbox/python_example_pkg_cloos
Project-URL: Homepage, https://github.com/netsandbox/python_example_pkg_cloos
Project-URL: Issues, https://github.com/netsandbox/python_example_pkg_cloos/issues
Project-URL: Source, https://github.com/netsandbox/python_example_pkg_cloos
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# example_pkg_cloos

[![PyPI](https://img.shields.io/pypi/v/example_pkg_cloos)](https://pypi.org/project/example-pkg-cloos/)
[![PyPI - License](https://img.shields.io/pypi/l/example_pkg_cloos)](https://pypi.org/project/example-pkg-cloos/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/example-pkg-cloos)](https://pypi.org/project/example-pkg-cloos/)
[![Python package](https://github.com/netsandbox/python_example_pkg_cloos/actions/workflows/python-package.yml/badge.svg)](https://github.com/netsandbox/python_example_pkg_cloos/actions/workflows/python-package.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A example package to learn and test Python packaging.

<https://packaging.python.org/tutorials/packaging-projects/>

## Development workflow

Checkout git repository:

```shell
git clone git@github.com:cloos/python_example_pkg_cloos.git
```

Install package in 'development mode':

```shell
make develop
```

Run tests:

```shell
make test
```

Create Git tag:

```shell
git tag -m "release 0.0.1" 0.0.1
git push --tags
```

Upload to <https://test.pypi.org/>:

```shell
make upload_test

```

Upload to <https://pypi.org/>:

```shell
make upload
```

## Usage

```shell
pip install example-pkg-cloos
```

Cli:

```shell
example-pkg-cloos --help
```

Library:

```python
from example_pkg_cloos.utils import print_bar, print_foo

print_bar()
print_foo()
```
