Skip to content
Snippets Groups Projects
Commit 3889b46f authored by Magnus Bredeli's avatar Magnus Bredeli
Browse files

Update README.md, bbcli/cli.py, bbcli/__version__.py

parent e36cafd7
No related branches found
No related tags found
No related merge requests found
......@@ -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:**
......
......@@ -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'
......@@ -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')
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment