Metadata-Version: 2.1
Name: example-pkg-cloos
Version: 1.0.1
Summary: A example package to learn and test Python packaging.
Home-page: https://github.com/cloos/python_example_pkg_cloos
Author: Christian Loos
Author-email: cloos@netsandbox.de
License: MIT
Platform: UNKNOWN
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 :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
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: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Description-Content-Type: text/x-rst
Requires-Dist: click (>=4.0)

example_pkg_cloos
=================

.. image:: https://img.shields.io/pypi/v/example_pkg_cloos.svg
   :target: https://pypi.org/project/example-pkg-cloos/

.. image:: https://img.shields.io/pypi/l/example_pkg_cloos.svg
   :target: https://pypi.org/project/example-pkg-cloos/

.. image:: https://img.shields.io/pypi/pyversions/example_pkg_cloos.svg
   :target: https://pypi.org/project/example-pkg-cloos/

.. image:: https://img.shields.io/travis/cloos/python_example_pkg_cloos/master.svg
   :target: https://travis-ci.org/cloos/python_example_pkg_cloos/

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/ambv/black
   :alt: Code style: black

A example package to learn and test Python packaging.

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

Development workflow
--------------------

Checkout git repository:

.. code:: shell

   $ git clone git@github.com:cloos/python_example_pkg_cloos.git

Create virtualenv:

.. code:: shell

   $ make venv

Activate virtualenv:

.. code:: shell

   $ source venv/bin/activate

Install/Upgrade packaging tools:

.. code:: shell

   $ make install

Install package in 'development mode':

.. code:: shell

   $ make develop

Run tests:

.. code:: shell

    $ make test

Create Git tag:

.. code:: shell

   $ git tag -m "release 0.0.1" 0.0.1
   $ git push --tags

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

.. code:: shell

   $ make upload_test

Upload to https://pypi.org/:

.. code:: shell

   $ make upload

Usage
-----

.. code:: shell

   $ pip install example-pkg-cloos

Cli:

.. code:: shell

   example-pkg-cloos --help

Library:

.. code:: python

   from example_pkg_cloos.utils import print_bar, print_foo

   print_bar()
   print_foo()


