Metadata-Version: 2.1
Name: ops-py-example-code
Version: 1.3.5
Summary: Code example
License: MIT License
        
        Copyright (c) 2024 Equinor
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi==2024.2.2
Requires-Dist: charset-normalizer==3.3.2
Requires-Dist: idna==3.6
Requires-Dist: pip==24.0
Requires-Dist: requests==2.31.0
Requires-Dist: setuptools==69.0.3
Requires-Dist: urllib3==2.2.0
Requires-Dist: wheel==0.42.0

# 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](https://realpython.com/documenting-python-code).

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](https://realpython.com/python-pep8/)


### How to build and distribute the code
Please refer to the [ops-py-generate-pyproject](https://pypi.org/project/ops-py-generate-pyproject) documentation.
