Skip to content

Commit 4b85510

Browse files
TexasCodingTexasCoding
committed
initial commit
0 parents  commit 4b85510

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+8397
-0
lines changed

‎.github/workflows/test-package.yaml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# inspired by https://jacobian.org/til/github-actions-poetry/
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
8+
env:
9+
POETRY_VERSION: 1.8.3
10+
ALPACA_API_KEY: ${{ secrets.ALPACA_API_KEY }}
11+
ALPACA_SECRET_KEY: ${{ secrets.ALPACA_SECRET_KEY }}
12+
jobs:
13+
build:
14+
runs-on: ${{ matrix.os }}
15+
strategy:
16+
max-parallel: 1
17+
fail-fast: false
18+
matrix:
19+
python-version: ["3.12"]
20+
os: [ubuntu-latest, macOS-latest]
21+
env:
22+
POETRY_VIRTUALENVS_IN_PROJECT: true
23+
steps:
24+
- uses: actions/checkout@v3
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: ${{ matrix.python-version }}
28+
29+
# Cache the installation of Poetry itself, e.g. the next step. This prevents the workflow
30+
# from installing Poetry every time, which can be slow. Note the use of the Poetry version
31+
# number in the cache key, and the "-0" suffix: this allows you to invalidate the cache
32+
# manually if/when you want to upgrade Poetry, or if something goes wrong.
33+
- name: cache poetry install
34+
uses: actions/cache@v4
35+
with:
36+
path: ~/.local
37+
key: poetry-cache-${{ runner.os }}-${{ matrix.python-version }}-${{ env.POETRY_VERSION }}
38+
39+
# Install Poetry. You could do this manually, or there are several actions that do this.
40+
# `snok/install-poetry` seems to be minimal yet complete, and really just calls out to
41+
# Poetry's default install script, which feels correct. I pin the Poetry version here
42+
# because Poetry does occasionally change APIs between versions and I don't want my
43+
# actions to break if it does.
44+
#
45+
# The key configuration value here is `virtualenvs-in-project: true`: this creates the
46+
# venv as a `.venv` in your testing directory, which allows the next step to easily
47+
# cache it.
48+
- uses: snok/install-poetry@v1
49+
with:
50+
version: 1.8.3
51+
virtualenvs-create: true
52+
virtualenvs-in-project: true
53+
54+
# Cache your dependencies (i.e. all the stuff in your `pyproject.toml`)
55+
- name: cache venv
56+
uses: actions/cache@v4
57+
with:
58+
path: .venv
59+
key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
60+
- run: poetry install --no-interaction --no-root
61+
if: steps.cache-deps.outputs.cache-hit != 'true'
62+
- run: poetry install --no-interaction
63+
- run: poetry run ruff check --fix
64+
- run: poetry run pytest

‎.gitignore‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
.idea/
9+
.vscode/
10+
# Distribution / packaging
11+
.Python
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
cover/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
db.sqlite3
63+
db.sqlite3-journal
64+
65+
# Flask stuff:
66+
instance/
67+
.webassets-cache
68+
69+
# Scrapy stuff:
70+
.scrapy
71+
72+
# Sphinx documentation
73+
docs/_build/
74+
75+
# PyBuilder
76+
.pybuilder/
77+
target/
78+
79+
# Jupyter Notebook
80+
.ipynb_checkpoints
81+
82+
# IPython
83+
profile_default/
84+
ipython_config.py
85+
86+
# pyenv
87+
# For a library or package, you might want to ignore these files since the code is
88+
# intended to run in multiple environments; otherwise, check them in:
89+
# .python-version
90+
91+
# pipenv
92+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
94+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
95+
# install all needed dependencies.
96+
#Pipfile.lock
97+
98+
# poetry
99+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
100+
# This is especially recommended for binary packages to ensure reproducibility, and is more
101+
# commonly ignored for libraries.
102+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
103+
#poetry.lock
104+
105+
# pdm
106+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
107+
#pdm.lock
108+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
109+
# in version control.
110+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
111+
.pdm.toml
112+
.pdm-python
113+
.pdm-build/
114+
115+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
116+
__pypackages__/
117+
118+
# Celery stuff
119+
celerybeat-schedule
120+
celerybeat.pid
121+
122+
# SageMath parsed files
123+
*.sage.py
124+
125+
# Environments
126+
.env
127+
.venv
128+
env/
129+
venv/
130+
ENV/
131+
env.bak/
132+
venv.bak/
133+
134+
# Spyder project settings
135+
.spyderproject
136+
.spyproject
137+
138+
# Rope project settings
139+
.ropeproject
140+
141+
# mkdocs documentation
142+
/site
143+
144+
# mypy
145+
.mypy_cache/
146+
.dmypy.json
147+
dmypy.json
148+
149+
# Pyre type checker
150+
.pyre/
151+
sandbox.py
152+
# pytype static type analyzer
153+
.pytype/
154+
155+
# Cython debug symbols
156+
cython_debug/
157+
158+
# PyCharm
159+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
160+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
161+
# and can be added to the global gitignore or merged into this file. For a more nuclear
162+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
163+
#.idea/

‎.pre-commit-config.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
repos:
2+
- repo: https://github.com/astral-sh/ruff-pre-commit
3+
# Ruff version.
4+
rev: v0.4.8
5+
hooks:
6+
# Run the linter.
7+
- id: ruff
8+
args: [ --fix ]
9+
# Run the formatter.
10+
- id: ruff-format

‎README.md‎

Whitespace-only changes.

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/conf.py‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
from pathlib import Path
2+
3+
4+
project = "PyAlpacaAPI"
5+
copyright = "MIT 2024, TexasCoding"
6+
author = "TexasCoding"
7+
release = "2.0.0"
8+
9+
extensions = [
10+
"myst_parser",
11+
"sphinx.ext.duration",
12+
"sphinx.ext.autosectionlabel",
13+
"sphinx.ext.autodoc",
14+
"sphinx.ext.napoleon",
15+
"autoapi.extension",
16+
"nbsphinx",
17+
]
18+
autoapi_type = "python"
19+
autoapi_dirs = [f"{Path(__file__).parents[2]}/src"]
20+
21+
templates_path = ["_templates"]
22+
exclude_patterns = []
23+
24+
html_theme = "sphinx_rtd_theme"
25+
html_static_path = ["_static"]

‎docs/source/index.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
% PyAlpacaAPI documentation master file, created by
2+
% sphinx-quickstart on Sun Jun 9 14:23:36 2024.
3+
% You can adapt this file completely to your liking, but it should at least
4+
% contain the root `toctree` directive.
5+
6+
# Welcome to PyAlpacaAPI's documentation!
7+
8+
```{toctree}
9+
:caption: 'Contents:'
10+
:maxdepth: 2
11+
12+
notebooks/usage
13+
```
14+
15+
# Indices and tables
16+
17+
- {ref}`genindex`
18+
- {ref}`modindex`
19+
- {ref}`search`

0 commit comments

Comments
 (0)