https://github.com/tbobm/etnawrapper

Python wrapper made for my school's apis
https://github.com/tbobm/etnawrapper

api-client pip python3 school-project

Last synced: 3 days ago
JSON representation

Python wrapper made for my school's apis

• Host: GitHub
• URL: https://github.com/tbobm/etnawrapper
• Owner: tbobm
• License: mit
• Created: 2017-06-14T12:42:07.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-04-20T14:52:41.000Z (over 3 years ago)
• Last Synced: 2024-10-05T23:05:31.478Z (about 1 month ago)
• Topics: api-client, pip, python3, school-project
• Language: Python
• Size: 82 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Etnawrapper

===========

Python wrapper made for my school's apis

Based on `a colleague's

documentation `__

Usage

-----

.. code:: python

    from etnawrapper import EtnaWrapper

    wrapper = EtnaWrapper(login='your_login', password='your_passwd')

    # In order to check if you can access the APIs, try this:

    infos = wrapper.get_user_info()

    # It should return informations about your profile

    print(infos)

    # {

    #   'id': 1,

    #   'login': 'user',

    #   'email': 'email',

    #   'logas': False,

    #   'groups': ['student'],

    #   'login_date': '2021-04-07 23:38:36',

    #   'firstconnexion': False

    # }

Tools

------------

This package provides an executable called `etna`.

Using this program, you will be able to get informations without developping your own implementations.

Current features:

- List current activities

Below is an example usage of this program:

.. code:: bash

    $ etna activities

    # Acitivities per module

In order to enable autocompletion, please refer to `click's autocomplete documentation `_

For bash:

.. code:: bash

    eval "$(_ETNA_COMPLETE=source_bash etna )"

Installation

------------

This package is available on Pypi. Simply install it using:

.. code:: bash

    $ pip install etnawrapper

Documentation

------------

You can generate the module documentation using:

.. code:: console

    $ pip install -r requirements-doc.txt

    $ make html

    $ cd build/html && python -m http.server

    Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...

Contibuting

-----------

Contibutions are welcome. Simply fork the project and make a pull

request.

Contributors

-----------

- `matteyeux `_