Welcome to msConsole 👋

A suite of tools that makes your MakeSchool life easier!

Prerequisites

What things you need to install the software and how to install them

- Homebrew
or
- Pipenv
- Python 3.4+

🚀 Getting Started

Homebrew

# tap the repo
brew tap tempor1s/msconsole https://github.com/tempor1s/msconsole
# install the CLI tool
brew install msconsole
# get a list of all the commands
ms

Non-Brew Users

# install pipenv
sudo pip install pipenv
# clone repository
git clone https://github.com/tempor1s/msconsole
# active the virtual enviornment
pipenv shell
# install modules into virtual environment
pipenv install
# change your directory to `msconsole`
cd msconsole
# test the script - should return a list of all available commands
python3 main.py

To Do

• Restructure to fit modular style
• Better file and script organization
• Complete meet module
• Touch up console module
• Complete library module
• Create Makschool Ascii Banner
• Restructure checkin module into module folder
• Refactor utils into a folder with different scripts
• Refactor utils file into multiple files for better scaling
• Refactor checkin credentials so that they are used application-wide (maybe login as well)

Built With

• Requests - HTTP library
• lxml - XML and HTML parsing library
• keying - Storing and accessing passwords library
• clint - Suite of tools for developing CLI applications.
• docopt - For making our CLI beautiful :)

Contribution Guidlines

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

1. Fork the repo and create your branch from master.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Use a Consistent Coding Style

• 4 spaces for indentation rather than tabs (or tabs that convert to spaces)
• You can try running pipenv install autopep8 --dev for style unification

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Contributors

Tha Ghost 💻

Ben Lafferty 💻

Tasfia Addrita 💻