Skip to main content

My Toy Package shows how to create and maintain a package.

Project description

My Toy Package

https://img.shields.io/pypi/v/my_toy_package.svg https://img.shields.io/travis/francois-durand/my_toy_package.svg Documentation Status Code Coverage

My Toy Package shows how to create and maintain a package.

The core of this package is a tutorial that gives a checklist of how to create and maintain your Python package, especially relying on Cookiecutter, by Audrey Roy Greenfeld, and PyCharm. We also use GitHub, ReadTheDocs, PyPI, Travis CI and Pyup.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.7.0 (2020-01-16)

  • Configure Codecov and add a Codecov badge.

  • Reach 100% of code coverage.

  • In the tutorial, explain how to configure Codecov.

0.6.1 (2019-12-20)

  • Add long_description_content_type in setup.py to avoid a warning in PyPI.

0.6.0 (2019-12-20)

  • You may need to restart your computer after installing git.

  • Cookiecutter now proposes argparse in addition to Click.

  • It is not necessary to add twine to requirements_dev.txt (cookiecutter now does it).

  • Update the procedure to install travis.

  • It is not necessary anymore to remove mentions of Python 2.7 (cookiecutter has removed them).

  • Remove the line modules from reference.rst.

  • Add ReadTheDocs theme in conf.py.

  • Create the directory build before setting up sphinx locally.

0.5.0 (2019-12-19)

  • Explain how to indicate the type of an argument in the docstring when it is an object of one of your classes.

0.4.3 (2019-12-19)

  • Correct the format of titles in HISTORY.rst to comply with PyPI’s demands.

0.4.2 (2019-12-19)

  • Separate the tutorial from the readme file, in the hope that it will solve the deployment problem on PyPI.

0.4.1 (2019-12-19)

  • Use numpy style of documentation instead of sphinx basic style.

  • In the readme, correct the explanations about Pyup.

  • Say more explicitly that some steps are optional, like setting a virtual environment or using pyup.

  • Added how to make travis run the doctests (thanks to Quentin Lutz).

  • Remove the version numbers from the dev requirements.

0.3.2 (2019-06-27)

  • Try to deploy again on PyPI.

0.3.1 (2019-06-27)

  • Try to deploy again on PyPI.

0.3.0 (2019-06-26)

  • Try to change the minor version number to solve deployment problem on PyPI.

0.2.5 (2019-06-26)

  • Downgrade dev requirements to try to solve deployment problem on PyPI.

0.2.4 (2019-06-26)

  • Try to tackle deployment problem on PyPI.

0.2.3 (2019-06-26)

  • Correct the procedure for version release.

0.2.2 (2019-04-03)

  • Minor updates in documentation.

0.2.1 (2019-03-27)

  • Update flake.

0.2.0 (2019-03-27)

  • Configuration for local build of documentation with Sphinx.

  • Release a version directly on Github’s website.

  • Minor edits in documentation.

0.1.6 (2018-03-06)

  • Minor edit in documentation.

0.1.5 (2018-03-06)

  • Patch upload subpackages.

0.1.0 (2018-03-06)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

my_toy_package-0.7.0.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

my_toy_package-0.7.0-py2.py3-none-any.whl (9.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file my_toy_package-0.7.0.tar.gz.

File metadata

  • Download URL: my_toy_package-0.7.0.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

File hashes

Hashes for my_toy_package-0.7.0.tar.gz
Algorithm Hash digest
SHA256 b8c5218e1a8ec67e5f67c2d91d89fd418929a88ebd960d65d152f1579fc67d85
MD5 3c4d0eb482d254606947f67414c64654
BLAKE2b-256 601d5ca39071f370b5ddcf98af042c1972a4c0355b8de3f69d6a8b21464b022a

See more details on using hashes here.

File details

Details for the file my_toy_package-0.7.0-py2.py3-none-any.whl.

File metadata

  • Download URL: my_toy_package-0.7.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

File hashes

Hashes for my_toy_package-0.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 251627f79b05a083be49906ae1454c89516857524a8ee6c5e49bc0c90786987e
MD5 6c2462d74621144cd5030cc76a4fe104
BLAKE2b-256 3ba66ef3dc740fe181c14605cd3ca0d368a5df6532ed3ea9e2156ffff9626abe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page