Skip to content
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

[Infra] Repo initialisation #2

Merged
merged 6 commits into from
Feb 6, 2024
Merged
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
48 changes: 48 additions & 0 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Documentation

on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch: {}

concurrency:
group: docs-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
test_qadence_ubuntu:
name: docs (ubuntu)
runs-on: ubuntu-latest
steps:

- name: Checkout Qadence
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: Build docs
run: |
hatch -v run docs:build
31 changes: 31 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -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
112 changes: 112 additions & 0 deletions .github/workflows/test_fast.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
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
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
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 package
run: |
hatch build
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
- 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
169 changes: 30 additions & 139 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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/
Loading