example-code
This example code is simply to demonstrate how Open Source Python code should be written, documented and structured.
The file structure should be organized as of the following:
src/
├─ requirements.txt
├─ simple_service/
│ ├─ __init__.py
│ ├─ simple_service.py
README.md
LICENSE
How the code should be written and documented
The code should include comments and proper documentation. Use Docstrings
Please refer to the documentation in the simple_service.py file of this package and to Documenting Python Code: A Complete Guide.
To write proper and understandable code, for you and for others to read, you may also refer to How to Write Beautiful Python Code With PEP 8
How to build and distribute the code
Please refer to the ops-py-generate-pyproject documentation.
Demo
Metadata
Release files for ops-py-example-code 1.3.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ops_py_example_code-1.3.12.tar.gz | 3.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ops_py_example_code-1.3.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.6 kB
Release files / ops_py_example_code-1.3.12.tar.gz
| Download URL | ops_py_example_code-1.3.12.tar.gz |
|---|---|
| Size | 3.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
01acdc551fb7f10c6963a74e76571ec15a99863f774e7b00300ac11d4ee76d71
|
|
BLAKE2b-256 checksum How to use checksums |
17303bb3b6cef2f50c84fc5e3c9b3452667c1392b29e4d85770f9d48db838138
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 22, 2025.
Transparency logRelease files / ops_py_example_code-1.3.12-py3-none-any.whl
| Download URL | ops_py_example_code-1.3.12-py3-none-any.whl |
|---|---|
| Size | 4.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8dc0c370f081903b2b52032a5e436c9e395ce3169323d38b452f40214ecec4e1
|
|
BLAKE2b-256 checksum How to use checksums |
9c6e40814d7da16fa255feef8b44cb7c73866fe62f695226fa2abba4009c9b56
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 22, 2025.
Transparency log