Skip to content

Commit

Permalink
Init repo
Browse files Browse the repository at this point in the history
  • Loading branch information
GratienDSX committed Dec 12, 2024
1 parent 570ad3a commit 8e62d1c
Show file tree
Hide file tree
Showing 65 changed files with 8,777 additions and 176 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

1. Import '...'
2. Call '....'
3. See error

### Expected behavior

A clear and concise description of what you expected to happen.

### Screenshots

If applicable, add screenshots to help explain your problem.

### Desktop (please complete the following information)

- OS: `[e.g. linux]`
- Python version(s): `[e.g. 3.12]`
- Dependencies versions: `[e.g. pydantic 2.6.4]`

### Additional context

Add any other context about the problem here.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
blank_issues_enabled: false
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---

### Is your feature request related to a problem? Please describe

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### Describe the solution you'd like

A clear and concise description of what you want to happen.

### Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

### Additional context

Add any other context or screenshots about the feature request here.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### What?

Explain with one or more sentences what this change is doing.

### Have you done?

- [ ] Code tests
- [ ] Update documentation
- [ ] Update [changelog](https://github.com/MAIF/arta/blob/main/CHANGELOG.md)

### Details to be checked: (optional)

If needed, add some details here in order to verify the change (e.g., how to test).

### Linked issues: (optional)

- Close ...
- Close ...
52 changes: 52 additions & 0 deletions .github/workflows/ci-cd-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: Documentation CI/CD
on:
push:
branches:
- main
tags:
- '*' # Later: \b[0-9]\.[0-9]+\.[0-9]+[ab]?[0-9]?\b
pull_request:
types:
- opened
- synchronize
branches:
- main

jobs:
build:
if: ${{ github.actor != 'dependabot[bot]' }}
name: Build doc
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install package with optional dependency 'doc'
run: |
python -m pip install --upgrade pip
pip install .[doc]
- name: Run MkDocs build
working-directory: ./docs
run: mkdocs build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: "docs/site/"
publish:
if: success() && startsWith(github.ref, 'refs/tags')
name: Publish doc
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
73 changes: 73 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Archives and compressed files
*.7z
*.7Z
*.gz
*.GZ
*.rar
*.RAR
*.tar
*.TAR
*.tar.*
*.TAR.*
*.tgz
*.TGZ
*.zip
*.ZIP

# Packages
*.egg
*.egg-info/
*.jar
*.war
*.ear

# Executable binary files
*.exe
*.EXE
*.msi
*.MSI
*.dll
*.DLL

# Log files
*.log
*.LOG
*.log.*
*.LOG.*
logs/*
LOGS/*

# Build directories
build/
target/*
*/target/*
cache/

# Crash files
hs_err_pid*

# Jupyter Notebook checkpoints
.ipynb_checkpoints

# Configuration files
.htaccess

# macOS specific files
*.DS_Store

# Data files
*.csv
data/

# Compiled Python files
*.pyc

# Environments
.env

# Development tools
.vscode
.coverage

# mkdocs documentation
*/site
22 changes: 22 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
default_language_version:
python: python3
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.8.0
hooks:
- id: ruff
args: [ --fix ]
- id: ruff-format
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.13.0
hooks:
- id: mypy
args: [--config-file=pyproject.toml]
files: src
additional_dependencies: [types-pytz,types-requests,types-python-dateutil]
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v3.6.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
args: []
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

## TODO
Loading

0 comments on commit 8e62d1c

Please sign in to comment.