From 7c933487acdb4ebd4b6fb77f777698a36874cfcf Mon Sep 17 00:00:00 2001 From: Roland Guichard Date: Mon, 5 Feb 2024 17:10:24 +0000 Subject: [PATCH] Adapt template to new package. --- .github/workflows/lint.yml | 31 ++++ .github/workflows/test_fast.yml | 108 +++++++++++ .gitignore | 169 ++++-------------- mkdocs.yml | 6 +- pyproject.toml | 125 +++++++------ {template_python => qadence_libs}/__init__.py | 0 {template_python => qadence_libs}/main.py | 0 7 files changed, 245 insertions(+), 194 deletions(-) create mode 100644 .github/workflows/lint.yml create mode 100644 .github/workflows/test_fast.yml rename {template_python => qadence_libs}/__init__.py (100%) rename {template_python => qadence_libs}/main.py (100%) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..6d2ce72 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,31 @@ +name: Linting + +on: + push: + branches: + - main + pull_request: {} + workflow_dispatch: {} + +jobs: + lint: + + runs-on: ubuntu-latest + + steps: + - name: Checkout Qadence Libs + uses: actions/checkout@v4 + + - name: Set up Python 3.x + uses: actions/setup-python@v5 + with: + python-version: '3.x' + + - name: Install pre-commit + run: | + pip install pre-commit + pre-commit install + + - name: Check files + run: | + pre-commit run --all-files diff --git a/.github/workflows/test_fast.yml b/.github/workflows/test_fast.yml new file mode 100644 index 0000000..3392d38 --- /dev/null +++ b/.github/workflows/test_fast.yml @@ -0,0 +1,108 @@ +name: Tests + +on: + push: + branches: + - main + tags: + - 'v[0-9]+.[0-9]+.[0-9]+' + pull_request: + branches: + - main + workflow_dispatch: {} + +concurrency: + group: fast-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + + test_libs_ubuntu: + name: Qadence Libs (ubuntu) + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.9", "3.10", "3.11"] + steps: + - name: Checkout Qadence Libs + uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + - name: Install Hatch + run: | + pip install hatch + - name: Run fast tests + run: | + hatch -v run test + - name: Upload coverage data + uses: actions/upload-artifact@v4 + with: + name: "coverage-data" + path: .coverage.* + if-no-files-found: ignore + + publish: + name: Publish to PyPI + if: startsWith(github.ref, 'refs/tags/v') + needs: test_libs_ubuntu + runs-on: ubuntu-latest + steps: + - name: Check out Qadence Libs + uses: actions/checkout@v4 + with: + ref: ${{ github.ref }} + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.10" + - name: Install Python dependencies + run: | + python -m pip install --upgrade pip + pip install hatch + - name: Build and publish package + run: | + hatch build + hatch publish -u ${{ secrets.HATCH_PYPI_USER }} -a ${{ secrets.HATCH_PYPI_AUTH }} + - name: Confirm deployment + timeout-minutes: 5 + run: | + VERSION=${GITHUB_REF#refs/tags/v} + until pip download qadence-libs==$VERSION + do + echo "Failed to download from PyPI, will wait for upload and retry." + sleep 1 + done + + deploy_docs: + name: Deploy Qadence Libs docs (ubuntu) + if: startsWith(github.ref, 'refs/tags/v') + needs: test_libs_ubuntu + runs-on: ubuntu-latest + steps: + - name: Checkout Qadence Libs + uses: actions/checkout@v4 + - name: Install JetBrains Mono font + run: | + sudo apt install -y wget unzip fontconfig + wget https://download.jetbrains.com/fonts/JetBrainsMono-2.304.zip + unzip JetBrainsMono-2.304.zip -d JetBrainsMono + mkdir -p /usr/share/fonts/truetype/jetbrains + cp JetBrainsMono/fonts/ttf/*.ttf /usr/share/fonts/truetype/jetbrains/ + fc-cache -f -v + - name: Install graphviz + run: sudo apt-get install -y graphviz + - name: Set up Python 3.10 + uses: actions/setup-python@v5 + with: + python-version: '3.10' + - name: Install Hatch + run: | + pip install hatch + - name: Deploy docs + run: | + git config user.name "GitHub Actions" + git config user.email "actions@github.com" + git fetch origin gh-pages + hatch -v run docs:mike deploy --push --update-aliases ${{ github.ref_name }} latest diff --git a/.gitignore b/.gitignore index 68bc17f..1b9910b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,160 +1,51 @@ +*.DS_Store +test.png +*.swp + +# Default ignored files +/.idea/ +/__pycache__/ +.vscode/ + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - # Unit test / coverage reports htmlcov/ .tox/ -.nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover -*.py,cover .hypothesis/ .pytest_cache/ -cover/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ +.mypy_cache/ -# PyBuilder -.pybuilder/ -target/ +# Distribution / packaging +.Python +*.egg-info/ +.installed.cfg +*.egg +build/ +dist/ # Jupyter Notebook .ipynb_checkpoints -# IPython -profile_default/ -ipython_config.py - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# poetry -# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. -# This is especially recommended for binary packages to ensure reproducibility, and is more -# commonly ignored for libraries. -# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control -#poetry.lock - -# pdm -# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. -#pdm.lock -# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it -# in version control. -# https://pdm.fming.dev/#use-with-ide -.pdm.toml - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - -# PyCharm -# JetBrains specific template is maintained in a separate JetBrains.gitignore that can -# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore -# and can be added to the global gitignore or merged into this file. For a more nuclear -# option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ +# specific +.*.db +*.db +*.eggs +*.env +Pipfile +runs/ +*venv +*~ +*lcov + +# Mkdocs +site/ diff --git a/mkdocs.yml b/mkdocs.yml index ff0ce87..bf5fc03 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Template Python project -repo_url: "https://gitlab.pasqal.com/pqs/template-python-project" -repo_name: "template_python_project" +repo_url: "https://github.com/pasqal-io/qadence-libs.git" +repo_name: "qadence_libs" nav: - Overview: index.md @@ -62,7 +62,7 @@ plugins: docstring_section_style: spacy watch: - - template_python + - qadence_libs extra: version: diff --git a/pyproject.toml b/pyproject.toml index a5dc527..43829f6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,69 +3,66 @@ requires = ["hatchling"] build-backend = "hatchling.build" [project] -name = "template_python" -description = "Pasqal quantum libraries template project in Python" +name = "qadence-libs" +description = "Libraries to extend Qadence functionalities." readme = "README.md" -version = "0.3.0" -requires-python = ">=3.9" -license = {text = "Proprietary"} -keywords = ["quantum"] authors = [ - { name = "Mario Dagrada", email = "mario.dagrada@pasqal.com" }, + { name = "Mario Dagrada", email = "mario.dagrada@pasqal.com" }, + { name = "Roland Guichard", email = "roland.guichard@pasqal.com" }, + { name = "Raja Selvarajan", email = "raja.selvarajan@pasqal.com" }, + { name = "Gergana Velikova", email = "gergana.velikova@pasqal.com" }, + ] -classifiers = [ - "Development Status :: 4 - Beta", - "Programming Language :: Python", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: Implementation :: CPython", - "Programming Language :: Python :: Implementation :: PyPy", +requires-python = ">=3.9,<3.12" +license = {text = "Apache 2.0"} +keywords = ["quantum"] +version = "0.1.1" +classifiers=[ + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", ] - -# always specify a version for each package -# to maintain consistency dependencies = [ - "pulser>=0.15.0" + "torch", + "qutip==4.7.2", + "qadence[braket, pulser, horqrux]==1.2.7", ] [tool.hatch.metadata] allow-direct-references = true allow-ambiguous-features = true -# add one or more extras in the dependencies -[project.optional-dependencies] -extras = [ - "pyqtorch", - "matplotlib>=3.5.0" -] - -# uncomment to enable installing libraries from the PASQAL private PyPi repository -# use a GitLab personal access token with registry permissions enable as credentials -#[tool.hatch.envs.default.env-vars] -#PIP_EXTRA_INDEX_URL = "https://{env:PYPI_USERNAME}:{env:PYPI_PASSWORD}@gitlab.pasqal.com/api/v4/projects/190/packages/pypi/simple" - -[project.urls] -Documentation = "https://pqs.pages.pasqal.com/template-python-project/" -Issues = "https://gitlab.pasqal.com/pqs/template-python-project/-/issues" -Source = "https://gitlab.pasqal.com/pqs/template-python-project" - [tool.hatch.envs.default] -features = ["extras"] dependencies = [ + "flaky", + "hypothesis", "pytest", "pytest-cov", + "pytest-mypy", "pytest-xdist", - "nbconvert", "ipykernel", "pre-commit", "black", - "ruff" + "isort", + "ruff", + "pydocstringformatter", ] +[tool.hatch.envs.default.scripts] +test = "pytest -n auto --cov-report lcov --cov-config=pyproject.toml --cov=qadence_libs --cov=tests --ignore=./tests/test_examples.py {args}" +test-examples = "pytest ./tests/test_examples.py {args}" +no-cov = "cov --no-cov {args}" +test-docs = "mkdocs build --clean --strict" +test-all = "pytest -n auto {args} && mkdocs build --clean --strict" + [tool.pytest.ini_options] testpaths = ["tests"] -addopts = """-vvv --cov-report=term-missing --cov-config=pyproject.toml --cov=template_python --cov=tests""" +addopts = """-vvv""" xfail_strict = true filterwarnings = [ "ignore:Call to deprecated create function FieldDescriptor", @@ -74,9 +71,11 @@ filterwarnings = [ "ignore:Call to deprecated create function EnumValueDescriptor", "ignore:Call to deprecated create function FileDescriptor", "ignore:Call to deprecated create function OneofDescriptor", - "ignore:distutils Version classes are deprecated." + "ignore:distutils Version classes are deprecated.", + "ignore::DeprecationWarning" ] + [tool.hatch.envs.docs] dependencies = [ "mkdocs", @@ -90,25 +89,30 @@ dependencies = [ ] [tool.hatch.envs.docs.scripts] -build = "mkdocs build --clean --strict {args}" +build = "mkdocs build --clean --strict" serve = "mkdocs serve --dev-addr localhost:8000" -test = "mkdocs build --clean --strict" [[tool.hatch.envs.test.matrix]] -python = ["39", "310", "311"] +python = ["39", "310"] + +# [tool.hatch.envs.tests] + +[tool.hatch.build.targets.sdist] +exclude = [ + "/.gitignore", + "/.gitlab-ci-yml", + "/.pre-commit-config.yml", + "/tests", + "/docs", + "/examples", +] [tool.hatch.build.targets.wheel] -packages = ["template_python"] +packages = ["qadence_libs"] [tool.coverage.run] branch = true parallel = true -# uncomment to omit any file from the -# coverage. Regexps can be used -# to select all files from a folder -#omit = [ -# "template_python/to_omit.py", -#] [tool.coverage.report] exclude_lines = [ @@ -119,7 +123,7 @@ exclude_lines = [ [tool.ruff] select = ["E", "F", "I", "Q"] -extend-ignore = ["F841"] +extend-ignore = ["F841","F403"] line-length = 100 [tool.ruff.isort] @@ -134,6 +138,23 @@ max-complexity = 15 [tool.ruff.flake8-quotes] docstring-quotes = "double" +[tool.black] +line-length = 100 +include = '\.pyi?$' +exclude = ''' +/( + \.git + | \.hg + | \.mypy_cache + | \.tox + | \.venv + | _build + | buck-out + | build + | dist +)/ +''' + [tool.mypy] python_version = "3.10" warn_return_any = true diff --git a/template_python/__init__.py b/qadence_libs/__init__.py similarity index 100% rename from template_python/__init__.py rename to qadence_libs/__init__.py diff --git a/template_python/main.py b/qadence_libs/main.py similarity index 100% rename from template_python/main.py rename to qadence_libs/main.py