Skip to content
This repository was archived by the owner on Dec 11, 2024. It is now read-only.

Commit 4a4452a

Browse files
yarnabrinayarnabrina
committed
Release v0.0.2
1 parent b9365a3 commit 4a4452a

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

+5509
-492
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 36 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ repos:
1616
- id: detect-private-key
1717
- id: end-of-file-fixer
1818
- id: mixed-line-ending
19-
- id: name-tests-test
20-
args:
21-
- --pytest-test-first
2219
- id: no-commit-to-branch
2320
- id: pretty-format-json
2421
args:
@@ -49,14 +46,16 @@ repos:
4946
- src
5047
pass_filenames: false
5148
- repo: https://github.com/psf/black
52-
rev: 23.12.1
49+
rev: 24.1.0
5350
hooks:
54-
- id: black-jupyter
51+
- id: black
52+
additional_dependencies:
53+
- .[jupyter]
5554
args:
5655
- src
5756
pass_filenames: false
5857
- repo: https://github.com/pycqa/bandit
59-
rev: 1.7.6
58+
rev: 1.7.7
6059
hooks:
6160
- id: bandit
6261
args:
@@ -68,24 +67,12 @@ repos:
6867
- src
6968
pass_filenames: false
7069
- repo: https://github.com/pycqa/flake8
71-
rev: 6.1.0
70+
rev: 7.0.0
7271
hooks:
7372
- id: flake8
7473
args:
7574
- src
7675
pass_filenames: false
77-
# - repo: https://github.com/pre-commit/mirrors-mypy
78-
# rev: v1.7.1
79-
# hooks:
80-
# - id: mypy
81-
# additional_dependencies:
82-
# - pydantic
83-
# args:
84-
# - --ignore-missing-imports
85-
# - --scripts-are-modules
86-
# pass_filenames: false
87-
# stages:
88-
# - manual
8976
- repo: https://github.com/PyCQA/pylint
9077
rev: v3.0.3
9178
hooks:
@@ -97,15 +84,8 @@ repos:
9784
pass_filenames: false
9885
stages:
9986
- manual
100-
# - repo: https://github.com/RobertCraigie/pyright-python
101-
# rev: v1.1.337
102-
# hooks:
103-
# - id: pyright
104-
# pass_filenames: false
105-
# stages:
106-
# - manual
10787
- repo: https://github.com/astral-sh/ruff-pre-commit
108-
rev: v0.1.9
88+
rev: v0.1.14
10989
hooks:
11090
- id: ruff
11191
args:
@@ -116,55 +96,46 @@ repos:
11696
hooks:
11797
- id: vulture
11898
pass_filenames: false
119-
# - repo: https://github.com/PyCQA/docformatter
120-
# rev: v1.7.5
121-
# hooks:
122-
# - id: docformatter
123-
# additional_dependencies:
124-
# - tomli
125-
# args:
126-
# - --in-place
127-
# - src
128-
# pass_filenames: false
129-
# - repo: https://github.com/adamchainz/blacken-docs
130-
# rev: 1.16.0
131-
# hooks:
132-
# - id: blacken-docs
133-
# args:
134-
# - --line-length
135-
# - "87"
136-
# - --target-version
137-
# - py311
138-
# - repo: https://github.com/econchick/interrogate
139-
# rev: 1.5.0
140-
# hooks:
141-
# - id: interrogate
142-
# args:
143-
# - src
144-
# pass_filenames: false
145-
# - repo: https://github.com/pycqa/pydocstyle
146-
# rev: 6.3.0
147-
# hooks:
148-
# - id: pydocstyle
149-
# additional_dependencies:
150-
# - tomli
151-
# args:
152-
# - src
153-
# pass_filenames: false
99+
- repo: https://github.com/PyCQA/docformatter
100+
rev: v1.7.5
101+
hooks:
102+
- id: docformatter
103+
additional_dependencies:
104+
- .[tomli]
105+
args:
106+
- --in-place
107+
- src
108+
pass_filenames: false
109+
- repo: https://github.com/adamchainz/blacken-docs
110+
rev: 1.16.0
111+
hooks:
112+
- id: blacken-docs
113+
args:
114+
- --line-length
115+
- "87"
116+
- --target-version
117+
- py311
118+
- repo: https://github.com/econchick/interrogate
119+
rev: 1.5.0
120+
hooks:
121+
- id: interrogate
122+
args:
123+
- src
124+
pass_filenames: false
154125
- repo: https://github.com/tox-dev/pyproject-fmt
155-
rev: 1.5.3
126+
rev: 1.7.0
156127
hooks:
157128
- id: pyproject-fmt
158129
- repo: https://github.com/abravalheri/validate-pyproject
159-
rev: v0.15
130+
rev: v0.16
160131
hooks:
161132
- id: validate-pyproject
162133
- repo: https://github.com/codespell-project/codespell
163134
rev: v2.2.6
164135
hooks:
165136
- id: codespell
166137
additional_dependencies:
167-
- tomli
138+
- .[toml]
168139
args:
169140
- --write-changes
170141
stages:

‎.readthedocs.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
python:
3+
install:
4+
- path: .
5+
method: pip
6+
extra_requirements:
7+
- doc
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
sphinx:
13+
builder: html
14+
configuration: docs/source/conf.py

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
# Query Package Documentation
2+
3+
* Installation: [PyPI](https://pypi.org/project/query-package-documentation/)
4+
* Documentation: [Read the Docs](https://query-package-documentation.readthedocs.io)

‎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/cli.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
cli module
2+
==========
3+
4+
.. automodule:: cli
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/conf.py‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
"""Configure Sphinx documentation."""
2+
# pylint: disable=invalid-name
3+
import sys
4+
5+
import generative_ai
6+
7+
sys.path.insert(0, "../src")
8+
9+
project = "query-package-documentation"
10+
version = str(generative_ai.__version__)
11+
project_copyright = "2024, Anirban Ray"
12+
author = "Anirban Ray"
13+
release = f"v{version}"
14+
15+
extensions = [
16+
"myst_parser",
17+
"sphinx.ext.autodoc",
18+
"sphinx.ext.intersphinx",
19+
"sphinx.ext.napoleon",
20+
"sphinx_copybutton",
21+
]
22+
source_suffix = {".md": "markdown", ".rst": "restructuredtext"}
23+
24+
smartquotes = False
25+
today_fmt = "%Y-%m-%d"
26+
highlight_language = "python3"
27+
pygments_style = "friendly"
28+
add_function_parentheses = False
29+
add_module_names = False
30+
option_emphasise_placeholders = True
31+
32+
html_theme = "furo"
33+
html_theme_options = {"top_of_page_button": None}
34+
html_title = f"{project} {release}"
35+
36+
html_last_updated_fmt = "%B %d, %Y"
37+
html_use_index = True
38+
html_split_index = False
39+
html_copy_source = False
40+
html_show_sourcelink = False
41+
html_show_sphinx = False
42+
html_output_encoding = "utf-8"
43+
44+
python_display_short_literal_types = True
45+
46+
myst_enable_extensions = [
47+
"amsmath",
48+
"attrs_inline",
49+
"colon_fence",
50+
"deflist",
51+
"dollarmath",
52+
"fieldlist",
53+
"html_admonition",
54+
"html_image",
55+
"linkify",
56+
"replacements",
57+
"smartquotes",
58+
"strikethrough",
59+
"substitution",
60+
"tasklist",
61+
]
62+
63+
autoclass_content = "class"
64+
autodoc_inherit_docstrings = True
65+
autodoc_member_order = "bysource"
66+
autodoc_typehints = "both"
67+
autodoc_typehints_description_target = "documented"
68+
autodoc_typehints_format = "short"
69+
70+
intersphinx_mapping = {
71+
"python": ("https://docs.python.org/3", None),
72+
"langchain": ("https://api.python.langchain.com/en/stable", None),
73+
"numpydoc": ("https://numpydoc.readthedocs.io/en/stable", None),
74+
}
75+
76+
napoleon_google_docstring = False
77+
napoleon_numpy_docstring = True
78+
napoleon_include_init_with_doc = False
79+
napoleon_use_param = True
80+
napoleon_use_keyword = True
81+
napoleon_use_rtype = True
82+
napoleon_preprocess_types = True
83+
84+
copybutton_prompt_text = r">>> |\.\.\. |\$ "
85+
copybutton_prompt_is_regexp = True
86+
copybutton_line_continuation_character = "\\"

‎docs/source/generative_ai.dataset_generation.orchestrate_generation.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
generative\_ai.dataset\_generation.orchestrate\_generation module
2+
=================================================================
3+
4+
.. automodule:: generative_ai.dataset_generation.orchestrate_generation
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/generative_ai.dataset_generation.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
generative\_ai.dataset\_generation package
2+
==========================================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
:maxdepth: 3
9+
10+
generative_ai.dataset_generation.orchestrate_generation
11+
generative_ai.dataset_generation.step_1_generation
12+
generative_ai.dataset_generation.step_2_generation
13+
generative_ai.dataset_generation.utils_generation
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: generative_ai.dataset_generation
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/generative_ai.dataset_generation.step_1_generation.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
generative\_ai.dataset\_generation.step\_1\_generation module
2+
=============================================================
3+
4+
.. automodule:: generative_ai.dataset_generation.step_1_generation
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)