ooti-api 0.0.3

SDK for ooti

SDK OOTI

Explore the docs »

Swagger: Docs API · ooti.co

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. How to use
4. License

About The Project

This sdk is for all people wanting to use the ooti API

Built With

• Python

Getting Started

Prerequisites

• Python 3.7
  • https://www.python.org/downloads/release/python-377/

Installation

1. Install virtual Environment

   pip install pipenv
   pipenv shell --python 3.7
   

2. Install ooti-api

   pip install ooti-api
   

3. Install requirements

   pip install -r requirements.txt
   

How to use

1. Import

   import sdk_ooti
   

2. Connect to the API

   my_account = sdk_ooti.Auth('email', 'password')
   my_account.connect()
   

3. Do a request

   invoices = my_account.get_invoices_list()
   

See the example.py file for more examples

Conventions

Python:

• Use docstring
• 120 character limit
• No python file greater than 2000 lines
• Follow pep8 https://www.python.org/dev/peps/pep-0008/
• In VisualStudio Code use ‘autopep8’: ("python.formatting.provider": "autopep8")

Branch names:

• feature-xxx
• improve-xxx
• bug-xxx
• hotfix-xxx

1 commit per modification

Use informative commit messages

learn more - https://gist.github.com/digitaljhelms/4287848

Key words:

• TODO: something todo
• TOOSLOW: Speed needs to be improved

Imports:

Good:

from operations.factories import OperationFactory
from discounts.selectors import discount_coefficient
from discounts.selectors import discount_list

Not good:

from operations.factories import OperationFactory
from discounts.selectors import (discount_coefficient,
                                 discount_list)

License

Copyright (C) 2016-2021 AxonePro S.A.S. [e-mail] All Rights Reserved

This file is part of axonepro.com.

Unauthorized copying of any file in this project, via any medium is strictly prohibited. Proprietary and confidential

axonepro.com can not be copied and/or distributed without the express permission of AXONEPRO.

HOW TO PUBLISHED IN PYPI

French tuto: https://sametmax.com/creer-un-setup-py-et-mettre-sa-bibliotheque-python-en-ligne-sur-pypi/

Twine documentation: https://twine.readthedocs.io/en/latest/

update ooti package version

   python setup.py sdist bdist_wheel
   python3 -m twine check dist/*
   python3 -m twine upload -r pypi dist/*
   python3 -m twine upload dist/* --skip-existing