Python packaging made easy
Project description
PyPacking
Use a short explanatory subtitle like, Create Python packages easily
PyPacking
is a Python package template. It provides the minimal set of
files and functionalities to create and distribute a python package
using PyPI
. This README
is one of the files you must provide with
the package. Change it according to the information you want to
provide the users.
To start a new package using this template follow this procedure (we
will assume that the name of your package is mypack
):
- Get
pypacking
template:git clone https://github.com/seap-udea/pypacking mypack
- Remove the
.git
directory. - Install system prerrequisites:
sudo apt install python3-pip gcc
- Install python prerrequisites:
pip3 install build twine
- Configure your package:
- Change variables in
.packrc
. - Change key variables in setup file
setup.py
. - Change package prerrequisites in
pyroject.toml
. - Change package name in
src/__init__.py
- Change variables in
- Create an account in
PyPI
and get a token and place it in$HOME/.pypirc
- Release your first version:
make release VERSION=0.0.1
Always start the README explaining clearly what your package do. If you can include here some beautiful image to call the attention of the potential user do it!
This is an example:
Download and install
Describe here how the package can be downloaded and install it in different arquitectures.
If you are using PyPI
installation it's as simple as:
pip install pypacking
Quick start
In this section you should provide the most simple instructions to use your package.
For instance:
import pypacking
print(pypacking.version)
Code examples
Provide some detailed examples for more advanced users.
For instance:
import pypacking
obj = MyClass()
What's new
If your package will be frequently updated with new features include a section describing the new features added to it:
Version 0.0.*:
- First version of the package.
This package has been designed and written by Fulanit@ de Tal (C) 202X
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file pypacking-0.0.2.tar.gz
.
File metadata
- Download URL: pypacking-0.0.2.tar.gz
- Upload date:
- Size: 3.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40f0bb4fedec94ad5ccda81d21e886ffe768f44630fe65a4624f7a6481e2d0f3 |
|
MD5 | 219034ecc46f5901cd7947e687623614 |
|
BLAKE2b-256 | a25da9ffaba773b66a6bf45e380377972c87bf38391a472befba8f3205138018 |