Merge pull request #4 from dnorhoj/rewrite

Version 0.2.0

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Build and deploy to PyPi
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.vscode/settings.json

@@ -1,9 +1,8 @@
 {
-    "python.pythonPath": "C:\\Users\\dnorh\\AppData\\Local\\Programs\\Python\\Python39\\python.exe",
-    "restructuredtext.confPath": "${workspaceFolder}\\docs",
     "python.linting.enabled": true,
     "python.linting.flake8Enabled": true,
     "python.linting.flake8Args": [
         "--ignore=E501"
-    ]
+    ],
+    "esbonio.sphinx.confDir": "${workspaceFolder}/docs"
 }

README.md

@@ -1,7 +1,9 @@
 # lectio.py
 
-![](https://img.shields.io/github/license/dnorhoj/lectio.py)
-
+[![License](https://img.shields.io/github/license/dnorhoj/lectio.py)](LICENSE)
+[![Documentation Status](https://readthedocs.org/projects/lectiopy/badge/?version=latest)](https://lectiopy.readthedocs.io/en/latest/?badge=latest)
+[![PyPi version](https://img.shields.io/pypi/v/lectio.py.svg)](https://pypi.org/project/lectio.py/)
+[![PyPi supported python versions](https://img.shields.io/pypi/pyversions/lectio.py.svg)](https://python.org/)
 
 *Please note: This library is nowhere close to done.*
 
@@ -14,13 +16,37 @@ You can read the documentation
 
 ## How do i use this?
 
-To use this repository feel free to check the documentation [here](https://lectiopy.rtfd.io/).
+You can install this library via `pip`:
+
+    pip install lectio.py
+
+For a quickstart guide as well as some examples, you can read the documentation [here](https://lectiopy.rtfd.io/).
+
+## Progress
+
+<details>
+    <summary>Implementation progress</summary>
+
+* [x] Schedule
+* [x] User info
+* [ ] Absence
+* [ ] Mail
+* [ ] Assignments
+* [ ] Homework
+* [ ] Surveys (Probably not going to be implemented)
+* [ ] Grades
+* [ ] Search for students / teachers
+
+</details>
 
 ## Todo
 
-* [ ] Finish authentication check
 * [ ] Make a better README
-* [ ] Start doing the hard part (basically everything)
+* [ ] Quickstart, Examples, etc.
+
+## Known bugs
+
+* Not made to work with teacher accounts (as i have no way of testing anything)
 
 ## Contributing
 
@@ -30,4 +56,4 @@ If you notice something that isn't working as intended you can start an issue.
 
 ## License
 
-This repository uses the `GNU Lesser General Public License v3.0` you can read more about it in [LICENSE](LICENSE).
+This repository uses the `GNU Lesser General Public License v3.0` you can read more about it in [LICENSE](LICENSE).

docs/conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'lectio.py'
-copyright = '2020, dnorhoj'
+copyright = '2022, dnorhoj'
 author = 'dnorhoj'
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.1'
+release = '0.2.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -1,9 +1,30 @@
-Welcome to lectio.py's documentation!
+Welcome to lectio.py
 =======================================
 
+Lectio.py is a Python library for reading and interacting with lectio.dk,
+a Danish school management system.
+
+.. note::
+    This library is not affiliated with lectio.dk or macom in any way.
+    Nor is it endorsed by them. It scrapes the website as there is no
+    official API.
+
+**Features:**
+
+- Pythonic API
+- Easy to use
+
+Information
+-----------
+
+**Useful links:** :doc:`/installation` | :doc:`/quickstart`
+**Reference:** :doc:`/reference` | :doc:`/exceptions`
+
+Table of contents
+-----------------
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
    installation
    quickstart

docs/installation.rst

@@ -1,4 +1,20 @@
 Installation
 ============
 
-TODO
+To install lectio.py and its dependencies, you can simply install it from PyPi::
+
+    pip install lectio.py
+
+or clone the repository and install it manually::
+
+    git clone https://github.com/dnorhoj/Lectio.py.git
+    cd lectio.py
+    python setup.py install
+
+You can check if the installation was successful by running::
+
+    python
+
+    >>> import lectio
+    >>> lectio.__version__
+

docs/quickstart.rst

@@ -1,4 +1,31 @@
 Quickstart
 ==========
 
-TODO
+Let's start with a simple example, where we will get your schedule for today.
+
+Schedule
+--------
+
+Create a new file, and add the following code:
+
+.. code-block:: python
+
+    from lectio import Lectio
+    from datetime import datetime, timedelta
+
+    lec = Lectio('<username>', '<password>')
+
+    # Get my user object
+    me = lec.me()
+
+    # Get the schedule for today
+    schedule = me.get_schedule(datetime.now(), datetime.now() + timedelta(days=1))
+
+We now have a list of all :class:`lectio.helpers.Module` in the ``schedule`` variable. Let's print it:
+
+.. code-block:: python
+
+    for module in schedule:
+        print(module.title, module.teacher, module.room)
+
+**More to come...!**

docs/reference.rst

@@ -1,6 +1,53 @@
+.. currentmodule:: lectio
+
 API Reference
 =============
 
-.. automodule:: lectio.lectio
+Lectio
+------
+
+.. autoclass:: Lectio
+    :members:
+    :undoc-members:
+
+
+School
+------
+
+.. autoclass:: lectio.models.school.School
+    :members:
+    :undoc-members:
+
+User
+----
+
+User
+^^^^
+
+.. autoclass:: lectio.models.user.User
+    :members:
+    :undoc-members:
+
+Me
+^^^
+
+.. autoclass:: lectio.models.user.Me
+    :members:
+    :undoc-members:
+
+User types
+^^^^^^^^^^
+
+.. autoclass:: lectio.models.user.UserType
+    :members:
+    :undoc-members:
+
+Misc
+----
+
+Module
+^^^^^^
+
+.. autoclass:: lectio.helpers.schedule.Module
     :members:
     :undoc-members:

lectio/__init__.py

@@ -1,4 +1,7 @@
 # flake8: noqa
-from .lectio import Lectio, Module
-from . import lectio
-from . import exceptions
+from .lectio import Lectio
+from .helpers.schedule import Module
+from .exceptions import *
+from .models.user import User, UserType
+from .models.school import School
+from .models import *

lectio/exceptions.py

@@ -1,3 +1,6 @@
+"""Here are all the custom Lectio.py exceptions as well as their explanation"""
+
+
 class LectioError(Exception):
     """Base lectio.py exception"""
 
@@ -8,3 +11,11 @@ class UnauthenticatedError(LectioError):
 
 class IncorrectCredentialsError(LectioError):
     """Incorrect credentials error, mostly thrown in auto-login on session expired"""
+
+
+class InstitutionDoesNotExistError(LectioError):
+    """The institution with the id you provided does not exist."""
+
+
+class UserDoesNotExistError(LectioError):
+    """The user does not exist."""

lectio/helpers/__init__.py

@@ -0,0 +1,2 @@
+# flake8: noqa
+from .schedule import *