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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49b8991e109c83d5d9b8a162386dbc47903747646dec42684761b5c27b8f208b |
|
MD5 | 2bb7522028ffdd072cd8c5f84b38e9fc |
|
BLAKE2b-256 | cff11074be36e2c04aaa754baf00cb60a9461e288ce4b9a34aaf8bf475e502c4 |
Close
Hashes for ops_py_example_code-1.3.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f90af6049e3b41f7805a735c4f43d65d02d60a4fe818ae77852d363437d4454 |
|
MD5 | bf698677c52067043f68cce901f451c2 |
|
BLAKE2b-256 | 93993d04fafd57c9cafa138393626a12d29468b25a1bc25af7c47cf54c8294ef |