fedora-python / Pello

MIT No Attribution
4 stars 5 forks source link

Pello

Pello is an example package that will be used as a part of Fedora Python Packaging Guidelines. The only thing that this package does is printing Hello World! on the command line.

Installation

In a virtual environment, run:

$ python -m pip install pello

If you want colorized output, install the color extra:

$ python -m pip install pello[color]

Running

You can run the pello_greeting command directly:

$ pello_greeting
Hello World!

You can also run the pello Python package:

$ python -m pello
Hello World!

Or you can use the Python API:

>>> import pello
>>> pello.greeting()
Hello World!

Tests

Run tests using Tox:

$ tox

This tests several Python interpreters (if they're available). It also checks for some “code quality” issues in a separate Tox environment, lint.

Contributing to Pello

Pull requests welcome, but keep in mind that this is an example package. Please coordinate major changes on Fedora's Python SIG mailing list.

Name & History

Beginner RPM packaging guides have traditionally featured simple example programs hello (in Bash), cello (in C) and pello (in Python).

This project is not a simple script, but a full Python project with associated metadata (in pyproject.toml and setup.py). This metadata should be converted, as automatically as possible, into RPM metadata.

Thanks to the capital P, Pello differs from the normalized name pello, so we can show where each of them is needed.