Code example
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for ops-py-example-code-1.3.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4150884ae9bd78eafc526f61c2656a4e234587dc4949e544067d2d17dc28af09 |
|
MD5 | f9daa2fc1e7f9344f4fee4e2c02f0290 |
|
BLAKE2b-256 | 94530d07ea91ba8ff784b6891899a7d585a996107c839c87df474697f4c24547 |
Close
Hashes for ops_py_example_code-1.3.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38cc45d5b410473d0ad58a01c098717f82cac5716ad1b05a032a78fcfd10c2db |
|
MD5 | 94333675e9c0e80381634d90291e3d3d |
|
BLAKE2b-256 | 0c5a04393a0516c7838576c4ae7b573a7643bc9ddcd2fc348b7fd5604b8edf8b |