Skip to content

Align python_requires, addition of requirements-dev.txt #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# ---------------------------------------------------------------------------
# Development Requirements for TorchQuantum
# ---------------------------------------------------------------------------
# This file lists dependencies needed for developing TorchQuantum,
# including testing, linting, formatting, and building documentation.
# Use 'pip install -r requirements-dev.txt' to install these.
# ---------------------------------------------------------------------------

# Include the core library requirements
-r requirements.txt

# === Code Style & Linting ===
# Used via pre-commit hooks (as mentioned in README)
pre-commit>=2.15.0 # Manages git hooks for checks
black>=22.3.0 # Uncompromising Python code formatter
# You might add other linters like flake8 or isort here if the project uses them

# === Testing ===
pytest>=6.0.0 # Standard testing framework for Python
# Add other testing plugins if needed (e.g., pytest-cov for coverage)

# === Documentation Building ===
# Dependencies needed to build the documentation locally (from setup.py extras)
Sphinx>=4.0.0 # Documentation generator tool
nbsphinx # Sphinx extension for rendering Jupyter Notebooks
recommonmark # Sphinx extension for Markdown support
# Add any other specific themes or extensions used (e.g., sphinx_rtd_theme)
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
license="MIT",
install_requires=requirements,
extras_require={"doc": ["nbsphinx", "recommonmark"]},
python_requires=">=3.5",
python_requires=">=3.7",# Align with README
include_package_data=True,
packages=find_packages(),
)