{ "info": { "author": "Vitor Falc\u00e3o Costa", "author_email": "vitorfhcosta@gmail.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# CFaster\n\nCFaster is a tool to easily set all you need to start a contest problem as fast as possible.\n\n## Get CFaster\n\nIf you want to install CFaster all you need is [pip](https://pypi.org/project/pip/) for Python 3 and running\n\n```bash\npip install cfaster\n```\n\n## Usage\n\n```bash\nUsage: cfaster [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n -v, --verbose Output INFO level logs.\n -d, --debug Output DEBUG level logs.\n --help Show this message and exit.\n\nCommands:\n scrape Scrapes the problem and saves inputs and outputs.\n```\n\n## Example\n\nThis command will scrape the problem from the link and get all the inputs and outputs in `.txt` files.\n\n```bash\ncfaster scrape https://codeforces.com/contest/1174/problem/A\n```\n\nIn the future we will have a `cfaster test` command for running your code, testing the inputs, comparing with the outputs and giving you the results.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nFor the default isolated development environment used by the maintainers you will need:\n\n- [Docker](https://docs.docker.com/install/)\n- [Docker Compose](https://docs.docker.com/compose/install/)(optional)\n- [Make](https://opensource.com/article/18/8/what-how-makefile)(optional)\n\nIf you prefer not using Docker feel free to use any other you prefer, but the CI integration will be running with Docker images so this is the best way to replicate the production environment.\n\n### Installing\n\nThis project uses [Docker](https://docs.docker.com/install/) for creating the isolated development environment.\n\nYou can run the Dockerfile build and run the container manually with\n\n```bash\ndocker build -t cfaster .\ndocker run -it --rm -v $(pwd):/cfaster cfaster bash\n```\n\nor you can use Make and docker-compose to easily get everything running\n\n```bash\nmake dev \n```\n\nReading the Makefile shows what each target does.\n\n### Using\n\nYou will have two options on how to execute from source code\n\n```bash\npython -m cfaster\n```\n\nor\n\n```bash\npython setup.py install\ncfaster\n```\n\n## Running the tests\n\n### Automated tests\n\nThe tests for the CFaster are yet to be implemented, the software still in early alpha version.\n\n### Coding style tests\n\nCFaster uses PEP8, for running a verification if your code is according to the rules use `pycodestyle .` which will recursively run through all files and find any mistakes.\n\nFor fixing them automatically we use `autopep8`\n\n```bash\nautopep8 -r --diff . # this will show the diff after the fixing\nautopep8 -r --in-place . # and this will fix in place the files\n```\n\nWe recommend always checking the diff first.\n\n## Deployment\n\nFor now we don't have a deployment pipeline, but in the future it will be automated using [CI](https://en.wikipedia.org/wiki/Continuous_integration) and [CD](https://en.wikipedia.org/wiki/Continuous_deployment) deploying the package to [pypi](https://pypi.org/).\n\n## Built With\n\n* [Python 3](https://www.python.org/) - The coding language used\n* [Click](https://click.palletsprojects.com/en/7.x/) - The command line interface package\n* [Beautiful Soup](https://www.crummy.com/software/BeautifulSoup/bs4/doc/) - Used to help scrapping the pages.\n\n## Contributing\n\nIf you want to contribute to the project please read [CONTRIBUTING](CONTRIBUTING.md)\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/vitorfhc/cfaster/tags). \n\n## Authors\n\n* **Vitor Falc\u00e3o** - *Starter and main maintainer* - [vitorfhc](https://github.com/vitorfhc)\n\nAs soon as we get out first contribution we will start the file with contributors.\n\n## License\n\nThis project is licensed under the GPL-3.0 - see the [LICENSE.md](LICENSE.md) file for details\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/vitorfhc/cfaster", "keywords": "contest,scraper,tools,codeforces,uva", "license": "", "maintainer": "", "maintainer_email": "", "name": "cfaster", "package_url": "https://pypi.org/project/cfaster/", "platform": "", "project_url": "https://pypi.org/project/cfaster/", "project_urls": { "Homepage": "https://github.com/vitorfhc/cfaster" }, "release_url": "https://pypi.org/project/cfaster/0.0.2/", "requires_dist": [ "beautifulsoup4 (==4.7.1)", "Click (==7.0)", "requests (==2.22.0)" ], "requires_python": "", "summary": "A package to get all you need to start a programming contest as fast as possible", "version": "0.0.2" }, "last_serial": 5371953, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "0070f4fa2d075ad668b1a87a26498847", "sha256": "79e95cc4267a09728b0fc4a134d26c95eea946ab5b7359a89a1eadc75b3bb836" }, "downloads": -1, "filename": "cfaster-0.0.1-py3.7.egg", "has_sig": false, "md5_digest": "0070f4fa2d075ad668b1a87a26498847", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 9779, "upload_time": "2019-06-06T04:47:00", "url": "https://files.pythonhosted.org/packages/8a/cd/e208586c98e5338c791808347fd8a85b75679d0b94235577895d1a4ef404/cfaster-0.0.1-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "5c7074e0ebc596ea210cd0ad1b892979", "sha256": "8fe24e39615e7e57d199cf4584b0e5f406e5298a104244ac894245f5cbe239ca" }, "downloads": -1, "filename": "cfaster-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "5c7074e0ebc596ea210cd0ad1b892979", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18089, "upload_time": "2019-06-06T04:46:57", "url": "https://files.pythonhosted.org/packages/80/b6/2e991f68b0832ddf95892273b4507524c4f81debf1b5985dca48bca4c545/cfaster-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7cfb6ac0560f455dd1bd0bc69265265d", "sha256": "a173c30d15f0a92a81dad8879078c38e9c31dddfa8d82406a41b3439ea7c69c0" }, "downloads": -1, "filename": "cfaster-0.0.1.tar.gz", "has_sig": false, "md5_digest": "7cfb6ac0560f455dd1bd0bc69265265d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4644, "upload_time": "2019-06-06T04:47:01", "url": "https://files.pythonhosted.org/packages/90/af/4ac9db717a97e6aa2643f277b38c447f520b2514408e34b289df01e45a6f/cfaster-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "48b8e792a3329a45647f43d37cee045c", "sha256": "27dd6c64d1172458fd095a6f8089d9a83d500fd46f5fe3def285e29ee58cef1f" }, "downloads": -1, "filename": "cfaster-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "48b8e792a3329a45647f43d37cee045c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18306, "upload_time": "2019-06-07T14:57:47", "url": "https://files.pythonhosted.org/packages/d6/2a/519b06752bc5a1cb107dcb2686627a4f1f5bd0b605923ca3dfe7a8d8e0d1/cfaster-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "703ef2d48544eac7087399081c4124d4", "sha256": "afe8316d6611cb1a8561243d7ab3ccbac1acd2484d4841ae694b6201be0ea793" }, "downloads": -1, "filename": "cfaster-0.0.2.tar.gz", "has_sig": false, "md5_digest": "703ef2d48544eac7087399081c4124d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4840, "upload_time": "2019-06-07T14:57:48", "url": "https://files.pythonhosted.org/packages/2c/47/261ef3bf546bb654d029278fafb5dd7b33cef83bf936581499bab179eea1/cfaster-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "48b8e792a3329a45647f43d37cee045c", "sha256": "27dd6c64d1172458fd095a6f8089d9a83d500fd46f5fe3def285e29ee58cef1f" }, "downloads": -1, "filename": "cfaster-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "48b8e792a3329a45647f43d37cee045c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18306, "upload_time": "2019-06-07T14:57:47", "url": "https://files.pythonhosted.org/packages/d6/2a/519b06752bc5a1cb107dcb2686627a4f1f5bd0b605923ca3dfe7a8d8e0d1/cfaster-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "703ef2d48544eac7087399081c4124d4", "sha256": "afe8316d6611cb1a8561243d7ab3ccbac1acd2484d4841ae694b6201be0ea793" }, "downloads": -1, "filename": "cfaster-0.0.2.tar.gz", "has_sig": false, "md5_digest": "703ef2d48544eac7087399081c4124d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4840, "upload_time": "2019-06-07T14:57:48", "url": "https://files.pythonhosted.org/packages/2c/47/261ef3bf546bb654d029278fafb5dd7b33cef83bf936581499bab179eea1/cfaster-0.0.2.tar.gz" } ] }