nome

A Python CLI to check if a package name is available in PyPI or npm.

References

• Ewen Le Bihan's check_availability CLI.
• Anton Zhiyanov's How to make an awesome Python package in 2021 blog post (repo).
• Development - Contributing page (FastAPI documentation).

Development

Current version of Python used for development: Python 3.6.13.

To set up the environment

• python -m venv env.
• source ./env/bin/activate.
  • Run which pip to see if it worked. The path must end in env/bin/pip.
  • Note: Whenever you install a new package with pip in this environment, activate it again.
• pip install flit==3.2.0.
  • Requests is one of the dependencies.
  • Documentation.
• flit install --deps develop --symlink.
  • To install all dependencies and nome in the local environment.
  • For Windows, replace --symlink with --pth-file.

To activate the environment

• source ./env/bin/activate.

Deployment

• Bump version (nome/__init__.py file).
• flit publish.

Notes

• Why isn't my desired project name available?:
  • requirements.txt is a prohibited project name.
• stdlib-list package.
• Python (3.6) Module Index.
• Flit:
  • Python packaging tool.
  • FastAPI uses it (pyproject.toml file).
  • Flit replaces setuptools, so you don't need the MANIFEST.in, setup.py, and/or setup.cfg files (source).
  • It is possible to add "Private :: Do Not Upload" to the classifiers list to prevent a private project from being uploaded to PyPI.
• Conventional Commits.
• IceCream package: alternative to print() for debugging.
• python -m venv env or python3 -m venv env (virtual environment with venv).
• cookiecutter-hipster-pypackage: it combines Pipenv and Flit.
• packaging package:
  • pip install packaging.
  • Version specifiers documentation.
  • Run python requests_version.py.
• whey (Python wheel builder).
• Cleo 0.8.1:
  • Does not expose verbosity flags (open) issue.
• nome = "nome.application:application.run" (more info here and here).
• VSCodeThemes (website to preview themes).
  • Palenight Theme.
• HTTP response status codes.

.pypirc file

[distutils]
index-servers =
   pypi

[pypi]
username = joaopalmeiro