forked from bukson/steampy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature: add pydoctor to generate automatic documentation
1 parent
30cf99d
commit c8bd55f
Showing
14 changed files
with
223 additions
and
173 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: ci-python-apidocs | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
- feature/add-docs-static-site-pydoctor | ||
|
||
jobs: | ||
ci-python-apidocs: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python 3.8 | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Install requirements for documentation generation | ||
run: | | ||
python -m pip install --upgrade pip setuptools wheel | ||
python -m pip install docutils pydoctor | ||
- name: Generate API documentation with pydoctor | ||
run: | | ||
pydoctor \ | ||
--project-name=steampy \ | ||
--project-url=https://github.com/$GITHUB_REPOSITORY \ | ||
--html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \ | ||
--make-html \ | ||
--html-output=./apidocs \ | ||
--project-base-dir="$(pwd)" \ | ||
--docformat=restructuredtext \ | ||
--intersphinx=https://docs.python.org/3/objects.inv \ | ||
./steampy | ||
- name: Push API documentation to Github Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./apidocs | ||
commit_message: "Generate API documentation" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,13 @@ | ||
Please make all pull request with 1 commit that can be easily rebased onto master. | ||
Contributions are the heartbeat of the open source community, transforming it into a vibrant space for learning, inspiring, and creating. Every contribution you bring adds immense value and is genuinely appreciated. | ||
|
||
Please add tests for new functions. | ||
If you have a suggestion to enhance the project, we encourage you to fork the repository and initiate a pull request. Alternatively, you can effortlessly open an issue, labeling it as "enhancement." And hey, don't forget to show your support by giving the project a star! Your efforts make a significant difference - thank you! | ||
|
||
Here's a quick guide to getting involved: | ||
|
||
- Fork the Project | ||
- Create your Feature Branch (git checkout -b feature/AmazingFeature) | ||
- Commit your Changes (git commit -m 'Add some AmazingFeature'). Make sure all pull requests contains only _1 commit_ that can be easily rebased onto master branch. Add tests for new functions. | ||
- Push to the Branch (git push origin feature/AmazingFeature) | ||
- Open a Pull Request | ||
|
||
Your contributions are the driving force behind the project's growth, and we're excited to collaborate with you! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
""" | ||
steampy is a library for Python, inspired by node-steam-tradeoffers, node-steam and other libraries for Node.js. | ||
It was designed as a simple lightweight library, combining features of many steam libraries from Node.js into a | ||
single python module. steampy is capable of logging into steam, fetching trade offers and handling them in simple | ||
manner, using steam user credentials and SteamGuard file, or by passing sessionID and webCookie cookies. 'steampy' | ||
is also capable of using proxies. | ||
steampy is developed with Python 3 using type hints and many other features its | ||
supported for Windows, Linux and MacOs. | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
""" | ||
Provides interactions with Steam | ||
""" | ||
import re | ||
import bs4 | ||
import json | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
""" | ||
Provides exceptions handled in Steam | ||
""" | ||
class SevenDaysHoldException(Exception): | ||
pass | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
""" | ||
Provides Steam Guard functions | ||
""" | ||
import os | ||
import hmac | ||
import json | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
""" | ||
Provides Login in Steam functions | ||
""" | ||
from http import HTTPStatus | ||
from base64 import b64encode | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
""" | ||
Provides Steam Market functions | ||
""" | ||
import json | ||
import urllib.parse | ||
from decimal import Decimal | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters