Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tempor1s/msconsole-old
Suite of tools that makes your MakeSchool life easier!
https://github.com/tempor1s/msconsole-old
Last synced: 28 days ago
JSON representation
Suite of tools that makes your MakeSchool life easier!
- Host: GitHub
- URL: https://github.com/tempor1s/msconsole-old
- Owner: tempor1s
- License: mit
- Created: 2019-11-19T06:49:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-14T05:39:34.000Z (over 3 years ago)
- Last Synced: 2023-03-07T21:45:36.934Z (almost 2 years ago)
- Language: Python
- Homepage:
- Size: 27.7 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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
```bash
- Homebrew
or
- Pipenv
- Python 3.4+
```
## 🚀 Getting Started
### Homebrew
```bash
# 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
```bash
# 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
- [x] Restructure to fit modular style
- [x] Better file and script organization
- [ ] Complete meet module
- [ ] Touch up console module
- [ ] Complete library module
- [x] Create Makschool Ascii Banner
- [x] Restructure checkin module into module folder
- [x] Refactor utils into a folder with different scripts
- [x] Refactor utils file into multiple files for better scaling
- [x] Refactor checkin credentials so that they are used application-wide (maybe login as well)
## Built With
- [Requests](https://2.python-requests.org/en/master/) - HTTP library
- [lxml](https://lxml.de/) - XML and HTML parsing library
- [keying](https://pypi.org/project/keyring/) - Storing and accessing passwords library
- [clint](https://pypi.org/project/clint/) - Suite of tools for developing CLI applications.
- [docopt](http://docopt.org/) - 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](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). 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](http://choosealicense.com/licenses/mit/) 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
