Skip to main content

A tool for easily create command-line interfaces.

Project description

atsuko

A tool for easily create command-line interfaces in Python.

I discovered that a tool like atsuko already exists and is much more advanced: its name is typer. It does exactly what I planned for atsuko to do, so I recommend using typer instead of atsuko.

I will stop developing this package.

Installation

Install atsuko using pip:

pip install atsuko

Usage

Here's a simple example of how to use atsuko to create a command-line interface:

import sys
from atsuko import CLI

# Create a new CLI application
app = CLI(
    name="my-app",
    description="A simple example application.",
    version="0.1.0"
)

@app.command
def greet(name: str):
    """Greets the given name."""
    app.log(f"Hello, {name}!")

if __name__ == "__main__":
    app.run(sys.argv[1:])

You can then run the application from the command line:

python my_app.py greet World
# Output: Hello, World!

Contributing

Contributions are welcome! Please feel free to submit a pull request.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

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

atsuko-0.2.1.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atsuko-0.2.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file atsuko-0.2.1.tar.gz.

File metadata

  • Download URL: atsuko-0.2.1.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for atsuko-0.2.1.tar.gz
Algorithm Hash digest
SHA256 d0afd7772d2f3a2d8762118050ccd65799ecaf934080cfbd69e51fd511f14c54
MD5 ff6a87ed729956c3eb04efe35d03d3b4
BLAKE2b-256 40c1a2ef69196cc0cdf9533af3a32aa5e5cbf2710a23c419e8907c426d421654

See more details on using hashes here.

File details

Details for the file atsuko-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: atsuko-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for atsuko-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e15336e2251db31d331e40e8b9caa6e5070fa3d4aedf0c74e1c4a49ec33fecb9
MD5 74b95016f71401b273aa204c5cc77c61
BLAKE2b-256 93440442cc3e37e4498570acf6afa7f85b7e7717f39d1ee5661deb13c22a16f3

See more details on using hashes here.

Supported by

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