axios


Nameaxios JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://github.com/zmoog/axios
SummaryCommand line utility to access https://family.axioscloud.it
upload_time2023-05-14 20:41:54
maintainer
docs_urlNone
authorMaurizio Branca
requires_python>=3.8
licenseApache License, Version 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # axios

Python library and CLI to access the school electronic register from Axios

[![PyPI](https://img.shields.io/pypi/v/axios.svg)](https://pypi.org/project/axios/)
[![Changelog](https://img.shields.io/github/v/release/zmoog/axios?include_prereleases&label=changelog)](https://github.com/zmoog/axios/releases)
[![Tests](https://github.com/zmoog/axios/workflows/Test/badge.svg)](https://github.com/zmoog/axios/actions?query=workflow%3ATest)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/zmoog/axios/blob/master/LICENSE)

Command line utility to access https://family.axioscloud.it

## Installation

Install this tool using `pip`:

    pip install axios

## Usage

First, set the environment variables:

    export AXIOS_CUSTOMER_ID="12345678909"
    export AXIOS_USERNAME="1234"
    export AXIOS_PASSWORD="a-secret-i-will-not-share"
    export AXIOS_STUDENT_ID="4567"

To list latest grades, run:

    $ axios grades list
                                                                                            Grades

      Data         Materia                      Tipo      Voto   Obiettivi   Commento                                                                                Docente
     ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
      2022-12-06   TECNOLOGIA e INFORMATICA     Scritto   7.5                                                                                                        Pavarin Maria Luisa
      2022-12-02   MATEMATICA                   Scritto   7,75               Verifica sugli insiemi                                                                  Micela Silvia
      2022-12-01   ARTE E IMMAGINE              Grafico   10                 Tav.3 figura e sfondo                                                                   Pagliarulo Veronica
      2022-12-01   ARTE E IMMAGINE              Grafico   7/8                Tav.1 Punto e linea                                                                     Pagliarulo Veronica
      2022-11-30   MUSICA                       Orale     7                  Verifica di carattere teorico. Interrogazione su tutto il programma svolto finora.      Cataldo Francesco
      2022-11-24   ITALIANO                     Scritto   8.5                Fonologia e ortografia                                                                  Rapalino Lara
      2022-11-23   TECNOLOGIA e INFORMATICA     Grafico   6.5                                                                                                        Pavarin Maria Luisa
      2022-11-23   MUSICA                       Orale     7,5                Verifica di carattere teorico. Interrogazione su tutto il programma svolto finora.      Cataldo Francesco
      2022-11-18   MATEMATICA                   Grafico   8,5                Verifica sulle equivalenze e le operazioni con le misure del tempo                      Micela Silvia
      2022-11-16   TECNOLOGIA e INFORMATICA     Grafico   7                                                                                                          Pavarin Maria Luisa
      2022-11-10   ARTE E IMMAGINE              Grafico   8                  Poster per la pace                                                                      Pagliarulo Veronica
      2022-11-09   LINGUA STRANIERA INGLESE     Scritto   8,5                Test units 1 e 2                                                                        Barbero Daniela

Defaults to current year and period.

To select a different year or period, run:

    # allowed values: FT01 and FT02
    axios --period FT02 grades list 

    # the year classes started
    axios --year 2021 grades list 
    
    # you can combine them, of course
    axios --year 2021 --period FT01

To format the output in JSON or NDJSON, run:

    $ axios --output-format json grades list
    [
        {
            "date": "2023-03-23",
            "subject": "ARTE E IMMAGINE",
            "kind": "Grafico",
            "value": "9",
            "teacher": "Pagliarulo Veronica",
            "comment": "Concorso LAV"
        },
        {
            "date": "2023-03-20",
            "subject": "STORIA",
            "kind": "Orale",
            "value": "10",
            "teacher": "Novelli Cristina",
            "comment": ""
        }
    ]

    $ axios --output-format ndjson grades list
    {"date": "2023-03-23", "subject": "ARTE E IMMAGINE", "kind": "Grafico", "value": "9", "teacher": "Pagliarulo Veronica", "comment": "Concorso LAV"}
    {"date": "2023-03-20", "subject": "STORIA", "kind": "Orale", "value": "10", "teacher": "Novelli Cristina", "comment": ""}

For help, run:

    axios --help

You can also use:

    python -m axios --help

## Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

    cd axios
    python -m venv venv
    source venv/bin/activate

Now install the dependencies and test dependencies:

    pip install -e '.[test]'

To run the tests:

    pytest

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/zmoog/axios",
    "name": "axios",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Maurizio Branca",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/48/94/21ff5540d5a618dd9d10875b7297131d58ebd55b8a96a0622df9f90548a5/axios-0.4.0.tar.gz",
    "platform": null,
    "description": "# axios\n\nPython library and CLI to access the school electronic register from Axios\n\n[![PyPI](https://img.shields.io/pypi/v/axios.svg)](https://pypi.org/project/axios/)\n[![Changelog](https://img.shields.io/github/v/release/zmoog/axios?include_prereleases&label=changelog)](https://github.com/zmoog/axios/releases)\n[![Tests](https://github.com/zmoog/axios/workflows/Test/badge.svg)](https://github.com/zmoog/axios/actions?query=workflow%3ATest)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/zmoog/axios/blob/master/LICENSE)\n\nCommand line utility to access https://family.axioscloud.it\n\n## Installation\n\nInstall this tool using `pip`:\n\n    pip install axios\n\n## Usage\n\nFirst, set the environment variables:\n\n    export AXIOS_CUSTOMER_ID=\"12345678909\"\n    export AXIOS_USERNAME=\"1234\"\n    export AXIOS_PASSWORD=\"a-secret-i-will-not-share\"\n    export AXIOS_STUDENT_ID=\"4567\"\n\nTo list latest grades, run:\n\n    $ axios grades list\n                                                                                            Grades\n\n      Data         Materia                      Tipo      Voto   Obiettivi   Commento                                                                                Docente\n     \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\n      2022-12-06   TECNOLOGIA e INFORMATICA     Scritto   7.5                                                                                                        Pavarin Maria Luisa\n      2022-12-02   MATEMATICA                   Scritto   7,75               Verifica sugli insiemi                                                                  Micela Silvia\n      2022-12-01   ARTE E IMMAGINE              Grafico   10                 Tav.3 figura e sfondo                                                                   Pagliarulo Veronica\n      2022-12-01   ARTE E IMMAGINE              Grafico   7/8                Tav.1 Punto e linea                                                                     Pagliarulo Veronica\n      2022-11-30   MUSICA                       Orale     7                  Verifica di carattere teorico. Interrogazione su tutto il programma svolto finora.      Cataldo Francesco\n      2022-11-24   ITALIANO                     Scritto   8.5                Fonologia e ortografia                                                                  Rapalino Lara\n      2022-11-23   TECNOLOGIA e INFORMATICA     Grafico   6.5                                                                                                        Pavarin Maria Luisa\n      2022-11-23   MUSICA                       Orale     7,5                Verifica di carattere teorico. Interrogazione su tutto il programma svolto finora.      Cataldo Francesco\n      2022-11-18   MATEMATICA                   Grafico   8,5                Verifica sulle equivalenze e le operazioni con le misure del tempo                      Micela Silvia\n      2022-11-16   TECNOLOGIA e INFORMATICA     Grafico   7                                                                                                          Pavarin Maria Luisa\n      2022-11-10   ARTE E IMMAGINE              Grafico   8                  Poster per la pace                                                                      Pagliarulo Veronica\n      2022-11-09   LINGUA STRANIERA INGLESE     Scritto   8,5                Test units 1 e 2                                                                        Barbero Daniela\n\nDefaults to current year and period.\n\nTo select a different year or period, run:\n\n    # allowed values: FT01 and FT02\n    axios --period FT02 grades list \n\n    # the year classes started\n    axios --year 2021 grades list \n    \n    # you can combine them, of course\n    axios --year 2021 --period FT01\n\nTo format the output in JSON or NDJSON, run:\n\n    $ axios --output-format json grades list\n    [\n        {\n            \"date\": \"2023-03-23\",\n            \"subject\": \"ARTE E IMMAGINE\",\n            \"kind\": \"Grafico\",\n            \"value\": \"9\",\n            \"teacher\": \"Pagliarulo Veronica\",\n            \"comment\": \"Concorso LAV\"\n        },\n        {\n            \"date\": \"2023-03-20\",\n            \"subject\": \"STORIA\",\n            \"kind\": \"Orale\",\n            \"value\": \"10\",\n            \"teacher\": \"Novelli Cristina\",\n            \"comment\": \"\"\n        }\n    ]\n\n    $ axios --output-format ndjson grades list\n    {\"date\": \"2023-03-23\", \"subject\": \"ARTE E IMMAGINE\", \"kind\": \"Grafico\", \"value\": \"9\", \"teacher\": \"Pagliarulo Veronica\", \"comment\": \"Concorso LAV\"}\n    {\"date\": \"2023-03-20\", \"subject\": \"STORIA\", \"kind\": \"Orale\", \"value\": \"10\", \"teacher\": \"Novelli Cristina\", \"comment\": \"\"}\n\nFor help, run:\n\n    axios --help\n\nYou can also use:\n\n    python -m axios --help\n\n## Development\n\nTo contribute to this tool, first checkout the code. Then create a new virtual environment:\n\n    cd axios\n    python -m venv venv\n    source venv/bin/activate\n\nNow install the dependencies and test dependencies:\n\n    pip install -e '.[test]'\n\nTo run the tests:\n\n    pytest\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Command line utility to access https://family.axioscloud.it",
    "version": "0.4.0",
    "project_urls": {
        "CI": "https://github.com/zmoog/axios/actions",
        "Changelog": "https://github.com/zmoog/axios/releases",
        "Homepage": "https://github.com/zmoog/axios",
        "Issues": "https://github.com/zmoog/axios/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f98b26c598e8971ee75e14479db4815391e54517a2245a7b4a644107984e9ce0",
                "md5": "baeef771fb24e978c485105ccf541128",
                "sha256": "f7002053ea2f1006ee9d691deb36b2411119479b675e9630a5da943b03b1ff52"
            },
            "downloads": -1,
            "filename": "axios-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "baeef771fb24e978c485105ccf541128",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7852,
            "upload_time": "2023-05-14T20:41:53",
            "upload_time_iso_8601": "2023-05-14T20:41:53.502038Z",
            "url": "https://files.pythonhosted.org/packages/f9/8b/26c598e8971ee75e14479db4815391e54517a2245a7b4a644107984e9ce0/axios-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "489421ff5540d5a618dd9d10875b7297131d58ebd55b8a96a0622df9f90548a5",
                "md5": "2c1563aecbfe4a9cd95cdc7f22570329",
                "sha256": "05ead76efd427e94ccc672e203a2b19fcbf4aafc4b8fc7060105f492f5be18a2"
            },
            "downloads": -1,
            "filename": "axios-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2c1563aecbfe4a9cd95cdc7f22570329",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 11412,
            "upload_time": "2023-05-14T20:41:54",
            "upload_time_iso_8601": "2023-05-14T20:41:54.686328Z",
            "url": "https://files.pythonhosted.org/packages/48/94/21ff5540d5a618dd9d10875b7297131d58ebd55b8a96a0622df9f90548a5/axios-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-14 20:41:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zmoog",
    "github_project": "axios",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "axios"
}
        
Elapsed time: 0.06763s