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 and upload to github from a some/one python file(s):

  1. Run the below command.
  2. Input yes at the first prompt as you will be questioned.
  3. Follow the instructions that will appear.
  4. 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 command to create/upload/update them all

cmpp

cmpp is shorthand of _createmypypackage

To update/upload a package to PyPi which already has a GitHub repo:

  1. Make all necessary changes in the python files(location: src/packagename/) in the github repo.
  2. Run the command (cmpp) as written above to submit to PyPi
  3. Input no at the first prompt.
  4. Follow the instructions that will appear.

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.5.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: createmypypackage-0.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 eef20e49f0149d82e5eb290ea7234cc7cb17b50c95b63e2aa71fd675e445c3ff
MD5 fe32d593c63fd33c86ce152cf3292b85
BLAKE2b-256 31945445c58b8fff1ec6134d75b1713ae07aad77da46176270c4c370fedb55e8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: createmypypackage-0.0.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bdaa2087e29164b083decdd46fbb9d75155745303f9c09635184a4bbb6baf745
MD5 d14d264d791e11f160fb4a281717d54b
BLAKE2b-256 947d1e5cf959343c00fe5d3bc9b3e9f762efe7c9bed31ad581c20fa4c3c0fbe0

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