Skip to content

Commit

Permalink
init commit
Browse files Browse the repository at this point in the history
  • Loading branch information
pazabol committed Jan 7, 2021
0 parents commit aa87044
Show file tree
Hide file tree
Showing 6 changed files with 440 additions and 0 deletions.
144 changes: 144 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Custom ignore
env.py
data
test.py
data.csv

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/
13 changes: 13 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]

[packages]
pandas = "*"
selenium = "*"

[requires]
python_version = "3.8"
119 changes: 119 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# When2STEM: automated scheduler for a student club

## Description

For the context, Fulbright STEM Club need to find common free time of the members for club meeting. Therefore, we collect data of (1) courses that members take and (2) schedule of all courses. Then we run algorithm to find the common free time slots. This repo contains the code for those tasks.

## Installation

### For beginners (using Thonny)

1. In Github, download the code by clicking in `Code` and `Download ZIP`

2. Install the libraries

We will install 2 packages: `selenium` and `pandas`. For each of these, in Thonny, go to `Tools -> Packages` and search the name of each package, then install them.

3. You're done. Now move to the **Execution** part.

### For pros

1. Clone this repo

2. Install packages:

* In your terminal, `cd` to this project folder
* `pip install pipenv` (for package management)
* `pipenv install` (automatically install all required packages shown in `pipfile.lock`)

## Execution

1. Launch `main.py` in your favorite way. For Thonny, click `Run` (or press `F5`).
2. Accept any pop up about permission blabla. There's no virus here.
3. Enjoy the automation!
7 changes: 7 additions & 0 deletions env_sample.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
'''
This is the sample of the env.py file. You should create a separate env.py file following this template and fill in your information.
'''

USERNAME = '[email protected]'
PASSWORD = 'password' # your real outlook password
CHROME_DRIVER_PATH = r"path\\to\\your\\chromedriver_file"
Loading

0 comments on commit aa87044

Please sign in to comment.