tomifier 0.0.5

A simple pyproject.toml initiator

tomifier

pyproject.toml is a modern way to create a Pathon package. tomifier is CLI to initialize a simple Python pyproject.toml file and starting code. The starting code is itself a CLI that can launch a FastAPI application.

References:

• pyproject.toml vs setup.py

Installation

pip install tomifier

Usage

Initialize on current Folder:

• tomifier init

Initialize on target folder:

• tomifier init -o target_folder/

Initialize with a project name and a target folder:

• tomifier init --name myproject1 --output target_folder/

Scaffolded files

The CLI will scaffold the following files and folder structure at the current folder or at the given target folder:

.
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── build.sh
├── mypackage1
│   ├── __init__.py
│   ├── cmd
│   │   ├── __init__.py
│   │   ├── root.py
│   │   └── static
│   │       └── index.html
│   └── version.py
├── pyproject.toml
├── requirements.txt
└── setup.py

Sample run

This is what a sample tomifier run looks like:

tomifier CLI
Description [My package]: Description for mypackage1                            
Author [Name]: 
Author email [[e-mail]]: 
Homepage [https://github.com/<usernane>/<repo>]: 
The following packages will be added by default: click, fastapi, and uvicorn[standard]
Command separated list of additional packages [ ]: 
Ready to inialize project. Proceed [Y/n]: 
Creating package: my-package1
Creating folder test1
New project iniatialized at: test1
Type: cd test1
 - Review the generated code
 - Check the package requirements in pyproject.toml and requirements.txt
 - To build the project type: sh.build

Note: if you intend to deploy the package to pypi.org, make sure that the name is available. Even if it is available, the name could be too close to another name preventing posting. If you end up having to choose a different name, you will need to rename the package directory and the package name references in the README.md,pyproject.toml and MANIFIST.in files

Sample generated pyproject.toml file

[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

[project]
name = "my-project1"
authors = [
  { name="Name", email="[e-mail]" },
]
description = "Description for myproject1"
readme = "README.md"
license = { file="LICENSE" }
requires-python = ">=3.10, <3.12"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
]
dependencies = [
  "click",
  "fastapi",
  "uvicorn[standard]"
]
dynamic = ["version"]

[tool.setuptools]
include-package-data = true

[tool.setuptools.dynamic]
version = {attr = "myproject1.version.VERSION"}
readme = {file = ["README.md"]}

[tool.setuptools.packages.find]
include = ["myproject1*"]
exclude = ["*.tests*"]
namespaces = false

[tool.setuptools.package-data]
"myproject1" = ["*.*"]

[project.urls]
"Homepage" = "https://github/usernane/repo"

[project.scripts]
myproject1 = "myproject1.cmd.root:main"

Note: the pyproject.toml contents of this file can be and most likely will need to be modified further to meet your needs.

Building the package

build.sh is a useful bash script included as part of the scaffolded code to build and deploy the package locally in editable mode.

To run it from a bash terminal type:

sh build.sh

The bash script includes the following commands:

rm -rf dist
pip uninstall <package_name> -y
python -m build
pip install -e .
<package_name> ui

Pushing the package to pypi.org

After building the package, to push the build to pypi.org using twine. Type:

# Verfify that the package name does not exist
# Install twine
pip install twine
# Make sure to get and install pypi.org token
# Publish the package
twine upload dis/*