A CLI boiler plate for current competition.
Project description
Don't Forget To Update StartCp-Cli Frequently, Thank You For Using
Use
pip install -U startcp-cli
orpip install startcp-cli==x.y.z
x.y.z is the latest version
A CLI application for generating battlespace in seconds for online coding competitions with features like custom template configuration, backup language support, auto input output files generation, etc. But, currently available for Codechef and Codeforces (version 1.0.2).
Made with :heavy_heart_exclamation: using Python3.
Usage
startcp-cli
is a command line application.pip install startcp-cli
orpip install startcp-cli==x.y.z
to install the package.- After installing use
startcp
command to start on the terminal. - First step is to generate a configuration file by simply entering
g
orgenerate
inside the sub startcp terminal. Follow the instructions to generate the config file. - After configuring the config file, you can use
cp <competition_url>
to generate the battlespace for the competition. - You can use
h
orhelp
on the sub startcp termininal to print the help message whenever needed.
Dependencies
-
startcp-cli
runs on Python3.x -
argparse
and our beloved -
Thanks to all :pray:
Installation (Not for development)
- Note: Please update globally installed package frequently. :innocent:
- Installing from
pypi
pip install startcp-cli
(use pip for Python3)- Already installed ?
- Update using
pip install -U startcp-cli
- see How To Update Pip Package
- Update using
- Installing Manually :
git clone https://github.com/asprazz/startcp-cli.git
cd startcp-cli
- Option 1:
- (if windows)
pip install .
- (if linux/mac)
sudo pip install . -H
- (if windows)
- Option 2:
- (optional for linux users) if requires
chmod +x install.sh
- then run
scripts/./install.sh
- (optional for linux users) if requires
- Option 1:
Configuration
startcp -g
orstartcp --generate
will generate configuration file in ${USER_HOME}/startcp/- By setting,
IS_SETUP_DONE = 1
in configuration file custom configuration can be used over default ones
Contributing Guidelines
- Thank you for Showing interest in contributing to this project
- Please see https://github.com/asprazz/startcp-cli/blob/master/CONTRIBUTORS.md
Development
- Please, follow the contributing guidelines
- Fork the repository and clone it to your local environment
- Activate environment if any (
venv
orconda
for more details ) - Running
startcp
- Running locally
cd startcp-cli
python startcp/__main__.py
- Installing globally from your local repository
cd startcp-cli
- Option 1:
- (if windows)
pip install .
- (if linux/mac)
sudo pip install . -H
- (if windows)
- Option 2:
- (optional for linux users) if requires
chmod +x install.sh
- then run
scripts/./install.sh
- (optional for linux users) if requires
- option 3:
python setup.py install
- Option 1:
- Running locally
- Fix :wrench: something broken or Build :hammer: something interesting
- Don't forget to create child branch from
develop
and that branch only
Error reports
- First of all thank you.
- https://github.com/asprazz/startcp-cli/issues
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
Built Distribution
File details
Details for the file startcp-cli-1.0.3.tar.gz
.
File metadata
- Download URL: startcp-cli-1.0.3.tar.gz
- Upload date:
- Size: 12.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97a564b8f4cea3d6c602cfe564d3c29807180ce6cd68b357c63db29b0f83a463 |
|
MD5 | 3ea049beca109f591f996d548579dbcb |
|
BLAKE2b-256 | d91c4eca22972dbef55bec89b42b72907c96bcc79b4300794b0d19db5f558979 |
File details
Details for the file startcp_cli-1.0.3-py3-none-any.whl
.
File metadata
- Download URL: startcp_cli-1.0.3-py3-none-any.whl
- Upload date:
- Size: 13.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d360c4fee57a47452f4989a0a8a7b0d6f8757756c3294d4d2cd38f914f6b4449 |
|
MD5 | 1771e013b30af5bec1e6c94ee97dedd0 |
|
BLAKE2b-256 | e8fb219452b430b383e9bcc0f9b319fafb0d47602ec7d05452b2aec006a0b2f0 |