Programming problem solution README table generator
Project description
sorcerer :crystal_ball:
Programming problem solution README table generator
Installation
You can simply use pip to install sorcerer:
$ pip install sorcerer
Arguments
--git, -g
: github username (required)
Usage
Run sorcerer as a command in your solutions directory
$ sorcerer -g [github username]
This will then look for a config.json
file that looks like this:
{
"Paths": ["Kattis", "Dmoj", "Leetcode"]
}
File Structure
sorcerer
as of now, requires a specific file structure in order to work.
example/
├── CSES
│ └── weirdalgorithm.cpp
├── Dmoj
│ ├── README.md
│ ├── anoisyclass.cpp
│ └── ccc11j1.py
├── Kattis
│ ├── README.md
│ ├── fenwick.cpp
│ ├── fenwick.py
│ └── gerrymandering.py
├── README.md
└── config.json
- The folder names must be the corresponding problem website names.
- The solution filenames must be the corresponding problem website problem IDs.
- The root folder name must be the name of your github repository.
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.
Source Distribution
sorcerer-1.0.0.tar.gz
(4.9 kB
view details)
File details
Details for the file sorcerer-1.0.0.tar.gz
.
File metadata
- Download URL: sorcerer-1.0.0.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b32c8258d797cd6bb840f35678b3dc3480ed63b15dc617b2fe11dc099db5e23 |
|
MD5 | c383d6290f3f9c6672427432b2bc2580 |
|
BLAKE2b-256 | 8bc0b93abcdb3be9d5259f0c7482047bde6decee361a6d5ba8a47234a7315b68 |