Programming problem solution README table generator
Project description
sorcerer
Programming problem solution README table generator
Installation
You can simply use pip to install sorcerer:
$ pip install sorcerer
Usage
Run sorcerer as a command
$ sorcerer
This will prompt you for your github repository link and absolute path to the repository.
Example
Github link to repository: https://github.com/sorcerer/example
Local path to repository: /Absolute/path/to/repository
This will then look for a config.json
file that looks something like this
{
"Ignore": ["CSES"],
"Paths": ["Kattis", "Dmoj", "Leetcode"]
}
File Structure
sorcerer
as of now, requires a specific file structure in order to work.
Github/lazy/example/
├── SITE_NAME
│ └── PROBLEM_ID
│ └── solution.cpp
├── SITE_NAME
│ ├── PROBLEM_ID
│ │ └── solution.cpp
│ └── PROBLEM_ID
│ └── solution.py
├── SITE_NAME
│ ├── PROBLEM_ID
│ │ ├── solution.cpp
│ │ └── solution.py
│ └── PROBLEM_ID
│ └── solution.py
├── README.md
└── config.json
Where PROBLEM_ID is the id for the solved problem and SITE_NAME is the problem website name.
For instance, https://open.kattis.com/problems/opensource -> Kattis/opensource/solution
Result
Potential sample result for a folder in the sample file structure above.
Kattis
Problem | Languages |
---|---|
Gerrymandering | Python |
Fenwick | C++, Python |
The current sites being supported can be found here. A full sample repository can be found here
Development
Fork the repository
$ git clone <fork>
$ pip3 install -r requirements.txt
$ python3 sorcerer
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.