Skip to content

Commit 2550a24

Browse files
tomsmokertomsmoker
committed
v0.1.2
0 parents  commit 2550a24

27 files changed

+3400
-0
lines changed

‎.DS_Store

6 KB
Binary file not shown.

‎.flake8

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[flake8]
2+
docstring-convention = numpy
3+
max-line-length = 79
4+
ignore =
5+
# slice notation whitespace, invalid
6+
E203
7+
# import at top, too many circular import fixes
8+
E402
9+
# line length, handled by bugbear B950
10+
E501
11+
# bare except, handled by bugbear B001
12+
E722
13+
# bin op line break, invalid
14+
W503
15+
# bin op line break, invalid
16+
per-file-ignores =
17+
tests/*:D

‎.github/workflows/main.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: all
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [main]
7+
8+
jobs:
9+
build:
10+
11+
runs-on: ${{ matrix.os }}
12+
strategy:
13+
matrix:
14+
os: [ubuntu-latest]
15+
python-version: ['3.10']
16+
17+
steps:
18+
- uses: actions/checkout@v2
19+
20+
- name: Set up Python ${{ matrix.python-version }}
21+
uses: actions/setup-python@v2
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
25+
- name: Install Python dependencies
26+
run: |
27+
python -m pip install --upgrade pip
28+
pip install -e .[dev]
29+
30+
- name: Lint with flake8
31+
run: |
32+
flake8 src tests examples
33+
34+
- name: Check style with black
35+
run: |
36+
black src tests examples
37+
38+
- name: Run security check
39+
run: |
40+
bandit -qr -c pyproject.toml src examples
41+
42+
- name: Run import check
43+
run: |
44+
isort --check src tests examples
45+
46+
- name: Run mypy
47+
run: |
48+
mypy src
49+
50+
- name: Test with pytest
51+
run: |
52+
pytest --color=yes

‎.gitignore

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

‎CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- First version of the docs
12+
- Change default examples to go in the prompt
13+
- Implement `query` method with the possibility of adding rules
14+
- Implement `upload_documents` method
15+
- Implement `get_index`, `create_index`, `__init__` methods and custom exceptions
16+
- Minimal package structure + CI
17+
- Installation instructions in the README
18+

‎CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing to Rule-based Retrieval
2+
3+
Thank you for your interest in contributing to the Rule-based Retrieval! We welcome contributions from the community to help improve and expand the capabilities of this project.
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
9+
If you encounter any bugs, have feature requests, or want to suggest improvements, please [open an issue](https://github.com/whyhow-ai/rule-based-retrieval/issues) on the GitHub repository. When creating an issue, please provide as much detail as possible, including steps to reproduce the problem, expected behavior, and any relevant code snippets or screenshots.
10+
11+
### Submitting Pull Requests
12+
13+
We encourage you to submit pull requests for bug fixes, new features, or improvements to the existing codebase. To submit a pull request, please follow these steps:
14+
15+
1. Fork the repository and create a new branch for your feature or bug fix.
16+
2. Make your changes in the new branch, ensuring that your code follows the project's coding style and conventions.
17+
3. Write appropriate tests for your changes and ensure that all existing tests pass.
18+
4. Update the documentation, including README.md and API references, if necessary.
19+
5. Commit your changes with descriptive commit messages.
20+
6. Push your changes to your forked repository.
21+
7. Open a pull request from your branch to the main repository's `main` branch.
22+
8. Provide a clear and detailed description of your changes in the pull request.
23+
24+
### Code Style and Conventions
25+
26+
To maintain a consistent codebase, please adhere to the following guidelines:
27+
28+
- Follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide for Python code.
29+
- Use meaningful variable and function names that accurately describe their purpose.
30+
- Write docstrings for all public functions, classes, and modules following the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
31+
- Ensure that your code is properly formatted and passes the project's linting checks.
32+
33+
### Testing
34+
35+
The Rule-based Retrieval package uses [pytest](https://docs.pytest.org/) for testing. When contributing, please make sure to:
36+
37+
- Write unit tests for any new functionality or bug fixes.
38+
- Ensure that all existing tests pass before submitting a pull request.
39+
- Add integration tests if your changes involve multiple components or complex scenarios.
40+
41+
To run the tests, use the following command:
42+
43+
```shell
44+
pytest tests/
45+
```
46+
47+
### Documentation
48+
Keeping the documentation up to date is crucial for the usability and adoption of the package. If your contributions involve changes to the public API or introduce new features, please update the relevant documentation files, including:
49+
50+
* README.md: Update the main README file with any necessary changes or additions.
51+
* docs/: Update the corresponding files in the docs/ directory to reflect your changes.
52+
53+
### Code of Conduct
54+
Please note that this project adheres to the Contributor Covenant Code of Conduct. By participating in this project, you are expected to uphold this code. Please report any unacceptable behavior to the project maintainers.
55+
56+
### License
57+
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
58+
59+
Thank you for your contributions and happy coding!

‎LICENCE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 WhyHow.ai
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)