Skip to main content

Provides a basic package structure

Project description

Makes python package creation easy again!

License: MIT stars Github All Releases PyPI python

Build Status Scrutinizer Code Quality Release date Latest Stable Version

tweet

Support me

Buy Me A Coffee

Most of the packages are simple and a collection of few functions or classes. We have created a package for that now that can create python packages, upload to github and distribute to pypi all in a single call. We collect desired packagename, author name and a few info interactively and create the package from a single python file. You can use multiple python scripts too. To use multiple scripts give a space seperated list when asked for file locations with main file (the file where all the functions and classes you want user to use is present) at the start. For simple packaging, one single file is enough.

  • Lightweight
  • Easiest to use with only one interactive command

Fun part: This package is also created by running the script located at src/createmypypackage/__init__.py

Install from PyPi

pip3 install createmypypackage

Or Install from main branch

pip3 install git+https://github.com/Souvic/createmypypackage.git

Example Usage

To make a new package:

  1. Run the below code to submit to PyPi
  2. Input yes at the first prompt.
  3. Make necessary changes if you have to (e.g. updating README.md file) now on the github repo before submitting to PyPi(by following the upload instruction below)

One code to create/upload/update them all

python3 -m createmypypackage

To update/upload a package:

  1. Make all necessary changes in the python files in the github repo
  2. Run the same code as above to submit to PyPi
  3. Input no at the first prompt.
  4. Input 1 at the second prompt if you are uploading for the first time.
  5. Input 2 at the second prompt if you have already submitted once. Change the version in that case to a higher number when prompted.
python3 -m createmypypackage 

Set up your $HOME/.pypirc file with the passtoken like this to save twine password to avoid typing username and password everytime Doc Link

Create $HOME/.pypirc and paste the below code replacing only _yourpasstoken

[pypi]
  username = __token__
  password = yourpasstoken

Use git store password utility to avoid typing GitHub username and password everytime Doc Link

Paste the below code for that with your passtoken and username

git credential-store --file ~/.mysecretfilelocation store
protocol=https
host=github.com
username=yourusername
password=passtoken

Important note:

You can use Github-flavored Markdown to write your content for your README.md

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

createmypypackage-0.0.4.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

createmypypackage-0.0.4-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file createmypypackage-0.0.4.tar.gz.

File metadata

  • Download URL: createmypypackage-0.0.4.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.0

File hashes

Hashes for createmypypackage-0.0.4.tar.gz
Algorithm Hash digest
SHA256 f9586f9cdf8b7b36afd25b6b00c12893dcb858f42c8a7d178c2c9b91dee7f249
MD5 e74cc12c87272641647b4f7e5e1afb46
BLAKE2b-256 12f24870e3da8e06370d557f00a9f6b545033bc7fe0c6b3aa0a3ee25802acd78

See more details on using hashes here.

File details

Details for the file createmypypackage-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: createmypypackage-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.0

File hashes

Hashes for createmypypackage-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7db64339c381fad16b2d40745ba531fbd2202dbe4faefb6d8b37e468e8045539
MD5 3300f85d63c29597bd7a78ef26c8aea5
BLAKE2b-256 ef437081dfe3798604f5ef19cbc7dc99a23c130fd9fdb33160043d73bab7c626

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