Skip to content

Commit

Permalink
Setup actions and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexgolec committed Apr 1, 2024
1 parent fdd502e commit d1e781b
Show file tree
Hide file tree
Showing 20 changed files with 1,254 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
patreon: TDAAPI
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: 'Report a bug '
title: ''
labels: ''
assignees: ''

---

## Please read the [bug submission guidelines](https://tda-api.readthedocs.io/en/latest/help.html) before submitting a bug.

Not following guidelines may result in your bug being ignored and/or closed.

**Description of Bug**
<DESCRIPTION>

**Code to Reproduce**
Paste in the code that causes the bug to occur.

IMPORTANT: Remember to anonymize your code. Be sure to replace API keys/Client IDs with placeholders. Also, never, ever share the contents of your token file.

**Expected Behavior**
<EXPECTED BEHAVIOR>

**Actual Behavior**
<ACTUAL BEHAVIOR>

**Error/Exception Log, If Applicable**
See here to learn how to turn on debug logging: https://tda-api.readthedocs.io/en/latest/help.html
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/looking-for-help--.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: 'Looking for Help? '
about: 'Get help on our Discord server: https://discord.gg/M3vjtHj'
title: ''
labels: ''
assignees: ''

---

Issues are not the place to ask for help. You can ask for help on our Discord server:

https://discord.gg/M3vjtHj

Issues filed asking for help will be ignored/closed.
74 changes: 74 additions & 0 deletions .github/workflows/python.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: tests

on:
- push
- pull_request

jobs:
test:
strategy:
fail-fast: false
max-parallel: 3
matrix:
platform: [ubuntu-latest, macos-latest, windows-latest]
python:
- version: "3.8"
toxenv: py38
- version: "3.9"
toxenv: py39
- version: "3.10"
toxenv: py310
- version: "3.11"
toxenv: py311
- version: "3.12"
toxenv: py312
runs-on: ${{ matrix.platform }}

steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python.version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python.version }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox
pip install ".[dev]"
- name: Test with tox ${{ matrix.python.toxenv }}
env:
TOXENV: ${{ matrix.python.toxenv }}
run: tox

- name: Report coverage
if: matrix.python.version == '3.8'
run: |
coverage combine
coverage report
coverage xml
- name: Upload coverage to Codecov
if: matrix.python.version == '3.8'
uses: codecov/[email protected]
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: ./coverage.xml
flags: unittests
name: GitHub
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python.version }}
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install ".[dev]"
- name: Build Docs
run: |
make -f Makefile.sphinx html
19 changes: 19 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
Empty file added docs/.empty
Empty file.
Empty file added docs/_static/.empty
Empty file.
Binary file added docs/_static/attempted-unauth-access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/discord-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/github-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/patreon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d1e781b

Please sign in to comment.