tomifier 0.0.3

A simple pyproject.toml initiator

tomifier

pyproject.toml is a modern way to create a python 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 web 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/

Created files

The CLI will create the following files and folder structure locally or at the target folder:

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

Sample Output from running the tool

tomifier init -n my-project1 -o project1
tomifier CLI
Description [My package]: Description for the project.
Author [Name]: 
Author email [[e-mail]]: 
Homepage [https://github/usernane/repo]: 
Comma separated packages (space=None) [click, fastapi, unvicorn[standard]]: 
Creating package myproject1 in folder myproj1 with author Name and email [e-mail]
Creating folder myproj1
New project iniatialize at: myproj1

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: this is a starting pyproject.toml file. The contents of this file can be modified further to meet your needs.

build.sh

build.sh is a useful bash script to start the build process and deploy the package locally in editable mode.

To run it from a bash terminal type:

sh build.sh

Pushing the file to pypi.org

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

pip install twine
# Make sure to get and install pypi.org token
twine upload dis/*