.
├── Pipfile
├── Pipfile.lock
├── README.md
├── .travis.yml
├── .gitignore
|
├── data
│ ├── demofile.json
│ └── testfile.json
|
├── scripts
│ ├── cogitate.sh
│ └── test.sh
├── src
│ ├── cogitate.py
│ ├── data_collection.py
│ ├── data_processor.py
│ ├── driller.py
│ ├── json_handler.py
│ └── __init__.py
└── tests
├── conftest.py
├── __init__.py
├── test_json_handler.py
└── test_driller.py
After pulling the repo, use pipenv shell in cogitate_tool/ to enter the virtual
environment. Use exit to exit. Under the virtual environment, use
pipenv install <package_name> --dev to install new packages for development.
Here is a good tutorial on how to use pipenv.
When under development, always install the virtual environment first by using
pipenv install --dev, then run the developing program by using
pipenv run python program_name.
The purpose of script is to automate the running or testing process. To make the
scripts take effect, add the following code to the Pipfile:
[scripts]
command_name = "./scripts/script_name.sh"
Here the command_name is the command you want to use when running the project.
For example, if the command_name is cogitate, the we can use pipenv run cogitate.
The homepage for argparse.
The homepage and documentation
for PyDriller.
The available attributes can be found at their homepage.