Skip to content

Commit ba0b650

Browse files
committed
Added wiki generator
1 parent 4ce26e7 commit ba0b650

File tree

6 files changed

+37
-9
lines changed

6 files changed

+37
-9
lines changed

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on: push
55
jobs:
66
build-n-publish:
77
name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
8-
runs-on: ubuntu-18.04
8+
runs-on: ubuntu-latest
99
steps:
1010
- uses: actions/checkout@master
1111
- name: Set up Python 3.7

.github/workflows/wiki.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Generate wiki
2+
3+
on: push
4+
5+
jobs:
6+
build-n-publish:
7+
name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v1
12+
- name: Install Python 3.7
13+
uses: actions/setup-python@v1
14+
with:
15+
python-version: 3.7
16+
- name: Install dependencies
17+
run: >-
18+
pip install pydoc-markdown mkdocs
19+
- name: Generate docs
20+
run: |
21+
mkdir docs
22+
pydoc-markdown -I codeforces_api/ --render-toc > docs/Home.md
23+
- name: Upload Documentation to Wiki
24+
uses: SwiftDocOrg/github-wiki-publish-action@v1
25+
with:
26+
path: docs/
27+
env:
28+
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Codeforces API [![License](https://img.shields.io/github/license/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/blob/master/README.md) [![Stars](https://img.shields.io/github/stars/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/stargazers) [![Forks](https://img.shields.io/github/forks/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/network/members) [![Issues](https://img.shields.io/github/issues/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/issues) ![Publish to PyPI and TestPyPI](https://github.com/VadVergasov/CodeforcesApiPy/workflows/Publish%20to%20PyPI%20and%20TestPyPI/badge.svg?branch=master)
1+
Codeforces API [![License](https://img.shields.io/github/license/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/blob/master/README.md) [![Stars](https://img.shields.io/github/stars/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/stargazers) [![Forks](https://img.shields.io/github/forks/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/network/members) [![Issues](https://img.shields.io/github/issues/VadVergasov/CodeforcesApiPy)](https://github.com/VadVergasov/CodeforcesApiPy/issues) ![Publish to PyPI and TestPyPI](https://github.com/VadVergasov/CodeforcesApiPy/workflows/Publish%20to%20PyPI%20and%20TestPyPI/badge.svg?branch=master) ![Generate wiki](https://github.com/VadVergasov/CodeforcesApiPy/workflows/Generate%20wiki/badge.svg?branch=master)
22
==========
33

44
Installing

codeforces_api/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Importing classes from modules
2+
Importing all classes from modules
33
"""
44
__all__ = ["CodeforcesApi", "CodeforcesApiRequestMaker", "CodeforcesParser"]
55
from codeforces_api.api_requests import CodeforcesApi

codeforces_api/api_requests.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Main class for requests.
2+
The main class for requests.
33
"""
44
import requests
55

@@ -86,7 +86,7 @@ def contest_standings(
8686
8787
Count defines how many submits will be returned.
8888
89-
Handles should be a list of handles to get (max 10000) but it is recommended to use less then 500, because http request length is set to 8000.
89+
handles should be a list of handles to get (max 10000) but it is recommended to use less than 500 because HTTP request length is set to 8000.
9090
9191
Room is the number of the room which is needed.
9292
@@ -122,9 +122,9 @@ def contest_status(self, contest_id, handle="", start=-1, count=-1):
122122
123123
From is replaced with a start, because from is reserved python word.
124124
125-
Count defines how many submits will be returned.
125+
count defines how many submits will be returned.
126126
127-
Handle is used for specifying a user.
127+
handle is used for specifying a user.
128128
129129
Returns parsed response from codeforces.com.
130130
"""
@@ -239,7 +239,7 @@ def user_info(self, handles):
239239
"""
240240
Get user.info.
241241
242-
Handles should be a list of users, up to 10000 but it is recommended to use less then 500, because http request length is set to 8000.
242+
Handles should be a list of users, up to 10000 but it is recommended to use less than 500 because HTTP request length is set to 8000.
243243
244244
Returns parsed response from codeforces.com.
245245
"""

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setup(
77
name="CodeforcesApiPy",
8-
version="1.2.5",
8+
version="1.3.0",
99
description="Implementation of codeforces.com API",
1010
platforms="any",
1111
url="https://github.com/VadVergasov/CodeforcesApiPy",

0 commit comments

Comments
 (0)