diff --git a/README.md b/README.md index a76982de82fe9a1c8cdb8f3d026330473d0f3bad..4f1bcf3e376479e8a034971476f3e2e47e2e9aab 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,6 @@ Options: --help Show this message and exit. Commands: - activate-shell-completion Activate shell completion for your shell announcements Commands for listing, creating, deleting and... assignments Commands for creating, listing and... contents Commands for listing, creating, deleting,... @@ -68,9 +67,13 @@ Blackboard LMS CLI is a command-line tool suite that students and staff can use ### Built With -The software is written in python and built with: +The software is written in python. Several libraries were used, but the most essential ones are: * [Click](https://click.palletsprojects.com/en/8.1.x/) - A python package for creating beautiful command line interfaces in a composable way with as little code as necessary. +* [Requests](https://docs.python-requests.org/en/latest/) - A library used to send HTTP requests in a simple and elegant way. +* [Beautiful Soup](crummy.com/software/BeautifulSoup/bs4/doc/) - A library used to pull data out from HTML and XML files. + +A complete list of all libraries can be found in the [dependencies](https://gitlab.stud.idi.ntnu.no/-/ide/project/mattiaae/idatt2900-072/tree/main/-/README.md/#L179) section. <!-- GETTING STARTED --> ## Getting Started @@ -79,7 +82,7 @@ Some instructions on how to quickly make the CLI available on your computer! ### Prerequisites -To run this CLI you need python and pip installed, as well as ```magic``` library, which is installed by following the installation guide beneath. +To run this CLI you need python and pip installed. ### Installation @@ -156,7 +159,7 @@ Using the ```--help``` flag is very useful, because many commands have many poss ## Dependencies -For this CLI to work you need python and pip installed on your computer. The CLI also uses the library [magic](https://pypi.org/project/python-magic/). +For this CLI to work you need python and pip installed on your computer. **The following libraries are required:** diff --git a/bbcli/__version__.py b/bbcli/__version__.py index 0b9f73f61b42282482d80521f82ac7824f94a736..aa1315bb0fa50e3796cd60cc5410630c3ab5b255 100644 --- a/bbcli/__version__.py +++ b/bbcli/__version__.py @@ -17,4 +17,4 @@ __url__ = 'https://gitlab.stud.idi.ntnu.no/mattiaae/idatt2900-072' __version__ = generate_version(VERSION, prerelease=PRERELEASE, revision=REVISION) __authors__ = 'Hans William Forebrigd, Mattias Aggentoft Eggen, Magnus Bredeli' __author_emails__ = 'hansw0701@gmail.com, mattias.a.eggen@gmail.com, magnus.bredeli@hotmail.com' -__license__ = 'Willyeh Wonkmeh 2.0' \ No newline at end of file +__license__ = 'Willyeh Wonkmeh 2.0' diff --git a/bbcli/cli.py b/bbcli/cli.py index 4ec36defe5c876fba9ad1eab7f6f010fc94286d4..e73ba11b74356a9456d5a8353664407752ad8c70 100644 --- a/bbcli/cli.py +++ b/bbcli/cli.py @@ -3,6 +3,7 @@ import requests from bbcli.utils.utils import set_cookies, set_headers from bbcli import __app_name__, __version__ import os +from bbcli.__version__ import VERSION from dotenv import load_dotenv from bbcli import check_valid_date import click @@ -166,4 +167,4 @@ def authenticate_user(): def clear_env(): open(f'{os.path.dirname(os.path.abspath(__file__))}/.env', 'w').close() - click.echo('Sucessfully logged out') \ No newline at end of file + click.echo('Sucessfully logged out')