Skip to main content

Programming problem solution README table generator

Project description


Build Status
Programming problem solution README table generator


You can simply use pip to install sorcerer:

$ pip install sorcerer


Run sorcerer as a command

$ sorcerer

This will prompt you for your github repository link and absolute path to the repository.


Github link to repository:
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.

│   └── PROBLEM_ID
│       └── solution.cpp
│   ├── PROBLEM_ID
│   │   └── solution.cpp
│   └── PROBLEM_ID
│       └──
│   ├── PROBLEM_ID
│   │   ├── solution.cpp
│   │   └──
│   └── PROBLEM_ID
│       └──
└── config.json

Where PROBLEM_ID is the id for the solved problem and SITE_NAME is the problem website name.
For instance, -> Kattis/opensource/solution


Potential sample result for a folder in the sample file structure above.


Problem Languages
Gerrymandering Python
Fenwick C++, Python

The current sites being supported can be found here. A full sample repository can be found here


Fork the repository

$ git clone <fork>
$ pip3 install -r requirements.txt
$ python3 sorcerer



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sorcerer, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size sorcerer-0.1.tar.gz (4.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page