diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md new file mode 100644 index 0000000..d114e66 --- /dev/null +++ b/docs/getting-started/installation.md @@ -0,0 +1,31 @@ +# Installation + +/// admonition | This project is in active development. + type: danger +There has not been an official release of PyZipline on PyPi yet, meaning these installation docs don't work. +/// + +## pip + +You can use pip to install PyZipline. +The command to use differs slightly depending on what OS/Distro you use. + +On Windows: + +``` prolog title="Command Prompt" +py -m pip install -U pyzipline +``` + +On macOS and Linux: + +``` prolog title="Bash" +python3 -m pip install pyzipline +``` + +## Poetry + +You can also use [Poetry](https://python-poetry.org/) to store your dependencies. Add PyZipline to your `pyproject.toml` file manually, or use this command: + +``` prolog title="Command Prompt / Shell" +poetry add pyzipline +``` diff --git a/docs/getting-started/usage.md b/docs/getting-started/usage.md new file mode 100644 index 0000000..8f04b05 --- /dev/null +++ b/docs/getting-started/usage.md @@ -0,0 +1 @@ +# Usage diff --git a/docs/index.md b/docs/index.md index 9fd24d3..4f55c73 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,20 +1,11 @@ # Welcome to PyZipline +/// admonition | This project is in active development. + type: warning +These docs are not complete yet, and there is a lot still to do. +/// + **PyZipline** is a Python API Wrapper for the [Zipline](https://zipline.diced.sh/) API. -Check out the :doc:`usage` section for further information, including -how to :ref:`install` the project. - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +Check out the [usage](getting-started/usage.md) section for further information, including +how to [install](getting-started/installation.md) the project. diff --git a/mkdocs.yml b/mkdocs.yml index 57254c8..2a50c97 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,13 +16,34 @@ nav: - Reference: ref/zipline.md plugins: + - git-revision-date-localized: + enable_creation_date: true - search - social -# - mkdocstrings: -# default_handler: python -# handlers: -# python: -# paths: [pyzipline] + # - mkdocstrings: + # default_handler: python + # handlers: + # python: + # paths: [pyzipline] + +markdown_extensions: + - abbr + - attr_list + - pymdownx.blocks.details + - pymdownx.blocks.admonition + - pymdownx.saneheaders + - pymdownx.magiclink + - pymdownx.mark + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.emoji: + emoji_index: !!python/name:pymdownx.emoji.twemoji + emoji_generator: !!python/name:pymdownx.emoji.to_svg extra_css: - css/external.css @@ -32,6 +53,9 @@ theme: palette: scheme: slate features: + - content.code.copy + - content.tooltips + - navigation.instant - search.suggest - search.highlight - search.share diff --git a/poetry.lock b/poetry.lock index 1a565ff..14f1034 100644 --- a/poetry.lock +++ b/poetry.lock @@ -567,6 +567,37 @@ python-dateutil = ">=2.8.1" [package.extras] dev = ["flake8", "markdown", "twine", "wheel"] +[[package]] +name = "gitdb" +version = "4.0.11" +description = "Git Object Database" +optional = false +python-versions = ">=3.7" +files = [ + {file = "gitdb-4.0.11-py3-none-any.whl", hash = "sha256:81a3407ddd2ee8df444cbacea00e2d038e40150acfa3001696fe0dcf1d3adfa4"}, + {file = "gitdb-4.0.11.tar.gz", hash = "sha256:bf5421126136d6d0af55bc1e7c1af1c397a34f5b7bd79e776cd3e89785c2b04b"}, +] + +[package.dependencies] +smmap = ">=3.0.1,<6" + +[[package]] +name = "gitpython" +version = "3.1.40" +description = "GitPython is a Python library used to interact with Git repositories" +optional = false +python-versions = ">=3.7" +files = [ + {file = "GitPython-3.1.40-py3-none-any.whl", hash = "sha256:cf14627d5a8049ffbf49915732e5eddbe8134c3bdb9d476e6182b676fc573f8a"}, + {file = "GitPython-3.1.40.tar.gz", hash = "sha256:22b126e9ffb671fdd0c129796343a02bf67bf2994b35449ffc9321aa755e18a4"}, +] + +[package.dependencies] +gitdb = ">=4.0.1,<5" + +[package.extras] +test = ["black", "coverage[toml]", "ddt (>=1.1.1,!=1.4.3)", "mock", "mypy", "pre-commit", "pytest", "pytest-cov", "pytest-instafail", "pytest-subtests", "pytest-sugar"] + [[package]] name = "idna" version = "3.6" @@ -760,6 +791,23 @@ files = [ Markdown = ">=3.3" mkdocs = ">=1.1" +[[package]] +name = "mkdocs-git-revision-date-localized-plugin" +version = "1.2.2" +description = "Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file." +optional = false +python-versions = ">=3.6" +files = [ + {file = "mkdocs-git-revision-date-localized-plugin-1.2.2.tar.gz", hash = "sha256:0c43a9aac1fa69df99a823f833cc223bac9967b60d5261a857761c7c6e3b30de"}, + {file = "mkdocs_git_revision_date_localized_plugin-1.2.2-py3-none-any.whl", hash = "sha256:85c7fe9ab06e7a63c4e522c26fee8b51d357cb8cbe605064501ad80f4f31cb94"}, +] + +[package.dependencies] +babel = ">=2.7.0" +GitPython = "*" +mkdocs = ">=1.0" +pytz = "*" + [[package]] name = "mkdocs-material" version = "9.5.2" @@ -1124,6 +1172,17 @@ files = [ [package.dependencies] six = ">=1.5" +[[package]] +name = "pytz" +version = "2023.3.post1" +description = "World timezone definitions, modern and historical" +optional = false +python-versions = "*" +files = [ + {file = "pytz-2023.3.post1-py2.py3-none-any.whl", hash = "sha256:ce42d816b81b68506614c11e8937d3aa9e41007ceb50bfdcb0749b921bf646c7"}, + {file = "pytz-2023.3.post1.tar.gz", hash = "sha256:7b4fddbeb94a1eba4b557da24f19fdf9db575192544270a9101d8509f9f43d7b"}, +] + [[package]] name = "pyyaml" version = "6.0.1" @@ -1326,6 +1385,17 @@ files = [ {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, ] +[[package]] +name = "smmap" +version = "5.0.1" +description = "A pure Python implementation of a sliding window memory map manager" +optional = false +python-versions = ">=3.7" +files = [ + {file = "smmap-5.0.1-py3-none-any.whl", hash = "sha256:e6d8668fa5f93e706934a62d7b4db19c8d9eb8cf2adbb75ef1b675aa332b69da"}, + {file = "smmap-5.0.1.tar.gz", hash = "sha256:dceeb6c0028fdb6734471eb07c0cd2aae706ccaecab45965ee83f11c8d3b1f62"}, +] + [[package]] name = "tinycss2" version = "1.2.1" @@ -1549,4 +1619,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.10 || ^3.11 || ^3.12" -content-hash = "1070a204613dc69e9ad727b9e46661862a10e852ac43f75a82450b72aa1da269" +content-hash = "7f033bf18f67a3fb4a4b9e15d8f6463f34152daab215ab5d113d6cf5df127411" diff --git a/pyproject.toml b/pyproject.toml index 1228ddd..560f7e9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,6 +24,7 @@ optional = true [tool.poetry.group.docs.dependencies] mkdocs = "1.5.3" mkdocstrings = "0.24.0" +mkdocs-git-revision-date-localized-plugin = "1.2.2" mkdocs-material = {extras = ["imaging"], version = "^9.5.2"} [build-system]