reveriee

Turn your idea into a published Python package. Create the project files with one command, then check everything before you upload.

Publishing your first Python package means getting a lot of small files and settings right. One wrong detail, like a version that already exists or a README full of stray symbols, only shows up after you upload, and a published version can never be changed. reverie sets up the boring parts correctly and warns you about the common mistakes first.

See it in action

Install

pip install reveriee

The package on PyPI is called reveriee, but the command you run is still reverie.

Create a new package

reverie new my-tool

reverie checks that the name is free on PyPI, asks for a one-line description and your name, and creates a ready-to-install project:

my-tool/
  pyproject.toml
  README.md
  LICENSE
  .gitignore
  my_tool/
    __init__.py
    __main__.py
    cli.py

The new project already installs and runs and prints a hello message. Open cli.py and replace the hello message with your own idea.

Check before you upload

Inside your project folder, run:

reverie check

or point it at a folder:

reverie check my-tool

It looks for the mistakes that most often hurt first-time publishers:

Every problem comes with a plain-language fix. Add --offline to skip the PyPI lookup.

Deep check (new in 0.2.0)

Because a published version can never be changed, run the thorough check right before you upload:

pip install build twine
reverie deepcheck

It does everything reverie check does, and then goes much further:

If everything is fine it says so. If not, it says exactly what is wrong and how to fix it. reverie never runs your program itself, it only checks that it can be loaded.

Options: --offline skips the PyPI lookup, --no-install skips the clean install test, --force runs the build tests even when the basic checks found problems.

Publish

When reverie deepcheck says all is fine, you need a free PyPI account and an API token. Then:

pip install build twine
python -m build
twine check dist/*
twine upload dist/*

Delete any old dist folder before you build.

Command not recognised?

On some Windows computers the reverie command is not found right after installing, because Windows does not know where pip put it. Start it through Python instead:

python -m reverie check

If pip says "defaulting to user installation" or "not writeable" while installing, that is normal and harmless.

Good to know

• reverie does not write your program for you. It sets up the packaging, and the idea is yours.
• It does not upload anything. You do that yourself with twine, after the check.
• Package names use lowercase letters, numbers and hyphens, like my-tool.
• The name check and the version check need an internet connection.

License

MIT