makepkg 0.0.1

Python packaging, made simple.

makepkg: A Python package for ...

Installation - development

Create a virtual environment, for example using venv:

$ python -m venv venv-makepkg
$ source venv-makepkg/bin/activate
$ mkdir makepkg
$ cd makepkg
$ python -m pip install -e .[dev]

Note that the last command installs a development environment, as it also installs packages needed for development, like black (for code formatting), pytest (for unit testing) and wheel (for creating wheel files from the package).

Testing

Running the tests requires to run the following command in the root folder (of course in the virtual environment):

(venv-makepkg) > pytest

If you use doctests in your docstrings (as makepackage assumes), you can run them using the following command (in the root folder):

(venv-makepkg) > python -m doctest makepkg/makepkg.py

In a similar way, you can run doctests from any other file that contains doctests.

Versioning

Remember to update package version once a change is made to the package and the new version is pushed to the repository. Don't forget about releases, too.

How to build a Python package?

To build the package, you need to go to the root folder of the package and run the following command:

(venv-makepkg) > python -m build .

Note that this assumes you have wheel installed in your virtual environment, and makepackage does this for you.

The built package is now located in the dist/ folder.

Publishing your package in PyPi

If you want to publish it to PyPi, you need to install twine, create an account there, and run the following command (also in the package's root folder):

(venv-makepkg) > twine upload dist/*

Nonetheless, if you first want to check what it will look like in PyPi, you can first upload the package to a test version of PyPi, that is,

twine upload -r testpypi dist/*

Check if everything is fine, and if so, you're ready to publish the package to PyPi.

Installation from PyPi

If the package is in PyPi, you can install it from there like any other Python package, that is,

pip install makepkg