optmagic version 1.1.1
This project enables you to create simple command line interfaces starting with a python class, or a python function that you want to expose directly to the shell.
It contains functionality which has not yet all been fully documented. Stay tuned.
Similar projects
Why not use one of those?
Ideally, the programmer should not have to specify anything extra than what the class or function already contains to expose its functionality. None of these other packages strive to accomplish that goal like optmagic does, as you can see in the following comparative examples.
TODO
Demo
TODO
Installing
To install the optmagic package, simply type the following command on your terminal:
$ pip3 install optmagic
Dependencies
The project depends on the following module for parsing the docstrings automatically:
docstring_parser
If you want to run the test suite for optmagic you will also need the following extra libraries:
pytestmatplotlibpbs3
Extra documentation
More documentation is available at:
http://xapple.github.io/optmagic/optmagic
This documentation is simply generated with:
$ pdoc3 --html --output-dir docs --force optmagic
1 maintainer
Metadata
1 maintainer
Release files for optmagic 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| optmagic-1.1.1.tar.gz | 8.4 kB | Without provenance | Details |
Release files / optmagic-1.1.1.tar.gz
| Download URL | optmagic-1.1.1.tar.gz |
|---|---|
| Size | 8.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e9e16f4c1a32785ff84e54ac0cd0229f7457f8a65cf6ca4ede00a238f3c9fe86
|
|
BLAKE2b-256 checksum How to use checksums |
77b8ac11780a86f3e0126eb842a8ef90a4edb7fbde8e5e1777cd21a85aad692c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.19
|
Security for optmagic 1.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
