Skip to main content

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, Codecov and Pyup.

Credits

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

History

0.9.0 (2020-01-22)

  • The cookiecutter now features a pytest configuration in tox.ini and a file .coveragerc.

  • As a consequence, it is not necessary anymore to add --doctest-modules when configuring the tests in PyCharm.

0.8.0 (2020-01-19)

  • Create our own cookiecutter: francois-durand/cookiecutter-my_toy_package.

  • In the tutorial:

    • Remove the steps that are now unnecessary, because they are included in the cookiecutter.

    • Create a section “Preliminaries” for the steps that are needed only once, not for every package creation.

    • Reorganize the order of the steps into a more natural course of action.

    • In PyCharm, change the documentation style to NumPy for all future package creations.

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.

Metadata

Release files for my-toy-package 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for my-toy-package 0.9.0
File Size Uploaded Provenance Actions
my_toy_package-0.9.0.tar.gz 17.9 kB Without provenance Details for my_toy_package-0.9.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for my-toy-package 0.9.0
File Interpreter ABI Platform Actions
my_toy_package-0.9.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for my_toy_package-0.9.0-py2.py3-none-any.whl

Total release size: 27.7 kB

Release files / my_toy_package-0.9.0.tar.gz

Download URL my_toy_package-0.9.0.tar.gz
Size 17.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3581fe152e348b74972219aedeacd49226ec1297e8b0fca3cd21a047222535a3
BLAKE2b-256 checksum
How to use checksums
42e740e67eb4082909e232a44526f63e43a4ff633310802e19394ba27a3989c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

Release files / my_toy_package-0.9.0-py2.py3-none-any.whl

Download URL my_toy_package-0.9.0-py2.py3-none-any.whl
Size 9.9 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
de905dabca72a07f97653e4b39148f7cf46a3273cf2ad78f28c733ea43a66b4d
BLAKE2b-256 checksum
How to use checksums
1b24e3cabb92ffbc517dbafb8d837e1e1a35d32002ccc1115c23e3576387af35
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

Security for my-toy-package 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page