Brunopaes / octo-template

This is a project template.

Octo Template

Optimized for python 3.6+

This is a project template. Used in other repositories.

---

Dependencies

For installing the requirements, in your venv or anaconda env, just run the following command:

pip install -r requirements.txt

---

Project's Structure

.
└── octo-template
    ├── data
    │   ├── data.csv
    │   ├── data.db
    │   └── data.xlsx
    ├── docs
    │   └── CREDITS
    ├── src
    │   ├── __init__.py
    │   └── settings.json
    ├── tests
    │   └── unittests
    │       └── __init__.py
    ├── .gitignore
    ├── LICENSE
    ├── README.md
    └── requirements.txt

Directory description

• data: The data dir. Group of non-script support files.
• docs: The documentation dir.
• src: The scripts & source code dir.
• tests: The unittests dir.

---

Usage Notes

Section aimed on clarifying some running issues.

Running

For running it, at the ~/src directory just run:

python octo-template.py

or, if importing it as a module, just run:

from octo-template import Template

if __name__ == '__main__':
    Template('args', 'kwargs').__call__()

JSON structure

{
  "API_URL": "",
  "API_KEY" : "",
  "API_PROXY": {
    "http": "",
    "https": ""
  }
}

obs: in order to run this application you must have a json file at ~/src/settings.json. This json must follow the structure above.

---