Skip to main content

Programming problem solution README table generator

Project description

sorcerer :crystal_ball:

Build Status Code style: black
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.

Files for sorcerer, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sorcerer-1.0.0.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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page