Skip to content

Latest commit

 

History

History
59 lines (54 loc) · 1.69 KB

README.md

File metadata and controls

59 lines (54 loc) · 1.69 KB

Code Curator

Python utility to generate an archive from code you've written on competitive programming platforms and organize them nicely. Here's an example of what is generated.

Supported platforms

  • DMOJ
  • Codeforces
  • SPOJ

Installation

Clone this repo

git clone https://github.com/shunr/code-curator.git
cd code-curator

Install dependencies

pip install -r requirements.txt

Create configuration file

cp config.example.json config.json

Usage

python3 curate.py

Configuration

Option Description
platforms Contains configuration for authentication on different platforms, one object per platform with username key. May contain password key if logging in is required
output_path Relative or absolute path to generate the repository
readme_name Filename of automatically generated table of contents (keep as README.md for GitHub)
readme_title Title that will be displayed in the header of the table of contents
readme_description Markdown description that will appear in the generated header

Sample configuration

{
  "platforms": {
    "dmoj": {
      "username": "wew_lad",
      "password": "correcthorsebatterystaple"
    },
    "codeforces": {
      "username": "niceindividual"
    },
    "spoj": {
      "username": "sample_text",
      "password": "falsecowcordednail"
    }
  },
  "output_path": "output",
  "readme_name": "README.md",
  "readme_title": "Competitive Programming Archive",
  "readme_description": "Curated automagically using [Code Curator](https://github.com/shunr/code-curator)"
}