Skip to content

Commit

Permalink
feat(setup): added python setup config
Browse files Browse the repository at this point in the history
  • Loading branch information
shinybrar committed Oct 24, 2023
1 parent 0d30737 commit e740204
Show file tree
Hide file tree
Showing 7 changed files with 916 additions and 0 deletions.
96 changes: 96 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
repos:
- hooks:
- args:
- --multi-line=3
- --trailing-comma
- --force-grid-wrap=0
- --use-parentheses
- --line-width=88
id: isort
repo: https://github.com/pycqa/isort
rev: 5.12.0
- hooks:
- args:
- --max-line-length=89
- --max-complexity=15
id: flake8
repo: https://github.com/pycqa/flake8
rev: 6.0.0
- hooks:
- args:
- --py36-plus
id: pyupgrade
repo: https://github.com/asottile/pyupgrade
rev: v3.3.1
- hooks:
- id: black
repo: https://github.com/psf/black
rev: 23.1.0
- hooks:
- additional_dependencies:
- types-attrs
- types-requests
- types-setuptools
- types-PyYAML
args:
- --ignore-missing-imports
- --no-implicit-optional
id: mypy
repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.0.0
- hooks:
- args:
- --convention=google
- --add-ignore=D104
id: pydocstyle
repo: https://github.com/pycqa/pydocstyle
rev: 6.3.0
- hooks:
- id: blacken-docs
repo: https://github.com/asottile/blacken-docs
rev: 1.13.0
- hooks:
- exclude: ^docs/*
id: trailing-whitespace
- exclude: ^docs/*
id: end-of-file-fixer
- id: debug-statements
- id: check-case-conflict
- id: check-json
- args:
- --unsafe
id: check-yaml
- id: mixed-line-ending
- id: check-toml
- id: pretty-format-json
- id: check-docstring-first
- id: check-symlinks
- id: detect-private-key
repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
- hooks:
- args:
- -iii
- -lll
id: bandit
repo: https://github.com/PyCQA/bandit
rev: 1.7.4
- hooks:
- additional_dependencies:
- radon
args:
- cc
- --min=C
- --total-average
entry: radon
id: radon
language: python
name: radon
verbose: true
repo: local
- hooks:
- id: commitizen
stages:
- commit-msg
repo: https://github.com/commitizen-tools/commitizen
rev: v2.41.0
17 changes: 17 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site_name: My Docs
784 changes: 784 additions & 0 deletions poetry.lock

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[tool.poetry]
name = "scicon"
version = "0.1.0"
description = "Science Containers for CANFAR"
authors = ["CANFAR <support@canfar.net>"]
license = "GNU Affero GPL v3.0"
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.9"


[tool.poetry.group.docs.dependencies]
mkdocs-material = "^9.4.6"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
Empty file added scicon/__init__.py
Empty file.
Empty file added scicon/images/__init__.py
Empty file.

0 comments on commit e740204

Please sign in to comment.