Skip to main content

A simple pyproject.toml initiator

Project description

tomifier

A CLI to initialize a simple Python pyproject.toml file with a simple executable CLI that can launch a web UI.

Installation

pip install tomifier

Usage

Initialize on current Folder:

  • tomifier init

Initialize on target folder:

  • tomifier init --output target_folder/

Initialize on with a project name and a target folder:

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

Files created

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

<package_name>/__init__.py
<package_name>/version.py
<package_name>/cmd/__init__.py
<package_name>/cmd/root.py
LICENSE
README
pyproject.toml
setup.py
buid.sh

Sample Output

 tomifier init --output myproj1
tomifier CLI
Package name [mypackage]: myproject1
Description [My package]: Description for myproject1
Author [Name]: 
Author email [name@email.com]: 
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 name@email.com
Creating folder myproj1
New project iniatialize at: myproj1

Generated pyproject.toml file

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

[project]
name = "myproject1"
authors = [
  { name="Name", email="name@email.com" },
]
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",
  "unvicorn[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"

build.sh

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tomifier-0.0.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

tomifier-0.0.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file tomifier-0.0.1.tar.gz.

File metadata

  • Download URL: tomifier-0.0.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for tomifier-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f54c8749140a17e4e13e09b6e660b85d52f990bcda4db704590ac6784f91d489
MD5 fa63f63ed39914a03fab221c0b74fd09
BLAKE2b-256 8003a95e1af1c6322ff786bcca84555ce6ca44f5dd7d3d1d5d16bb193334bca9

See more details on using hashes here.

File details

Details for the file tomifier-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: tomifier-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for tomifier-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7336ac17ae8ce48140f9820d44f724c91026b3c345cb0d588a0a2eea2a6757c3
MD5 68e431d40a305675d2dda7322466dd85
BLAKE2b-256 f3ee2f9ea7e34de3befd441ef14202fd2112da44a4e47d1c42bd6aac1d018790

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page