Skip to content

Commit 6cd4a5b

Browse files
pabloitupabloitu
committed
build: added tox workflow and text file with requirements for dev installation
build: added basic setups and .toml and .yml for conda build brand: added dbcsep logo and svg generator in docs folder (path in consistency with pycsep and floatcsep dir tree). repo: added basic repo files.
1 parent a9b375e commit 6cd4a5b

16 files changed

+672
-0
lines changed

‎.github/workflows/build-sphinx.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: docs
2+
3+
on:
4+
push:
5+
branches-ignore:
6+
- 'v*'
7+
pull_request:
8+
branches: [ main ]
9+
10+
jobs:
11+
build_docs:
12+
runs-on: ubuntu-latest
13+
defaults:
14+
run:
15+
shell: bash -l {0}
16+
17+
steps:
18+
- uses: actions/checkout@v2
19+
- uses: mamba-org/setup-micromamba@v1
20+
with:
21+
generate-run-shell: true
22+
environment-file: environment.yml
23+
create-args: >-
24+
python=${{ matrix.python-version }}
25+
26+
- name: Install pip dependencies
27+
run: |
28+
pip install -r requirements_dev.txt
29+
30+
- name: Install floatCSEP
31+
run: |
32+
pip install --no-deps -e .
33+
python -c "import dbcsep; print('Version: ', dbcsep.__version__)"
34+
35+
- name: Build documentation
36+
run: |
37+
make -C docs clean
38+
make -C docs html

‎.github/workflows/build-test.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: tests
2+
3+
on:
4+
push:
5+
branches-ignore:
6+
- 'v*'
7+
pull_request:
8+
9+
jobs:
10+
build:
11+
if: github.repository == 'cseptesting/dbcsep'
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
fail-fast: false
15+
matrix:
16+
os: [ubuntu-latest, macos-latest]
17+
python-version: ['3.11']
18+
defaults:
19+
run:
20+
shell: bash -l {0}
21+
22+
steps:
23+
- uses: actions/checkout@v2
24+
- uses: mamba-org/setup-micromamba@v1
25+
with:
26+
generate-run-shell: true
27+
environment-file: environment.yml
28+
create-args: >-
29+
python=${{ matrix.python-version }}
30+
31+
32+
- name: Install floatCSEP
33+
run: |
34+
pip install pytest pytest-cov
35+
pip install --no-deps -e .
36+
python -c "import dbcsep; print('Version: ', dbcsep.__version__)"
37+
38+
- name: Test with pytest
39+
run: |
40+
pytest --cov=./ --cov-config=.coveragerc
41+
42+
- name: Upload coverage
43+
if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'
44+
run: |
45+
bash <(curl -s https://codecov.io/bash) || echo 'Codecov failed to upload'

‎.github/workflows/publish-pypi.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Build and upload to PyPI
2+
3+
# Only build on tagged releases
4+
on:
5+
push:
6+
tags:
7+
- '*'
8+
9+
jobs:
10+
build:
11+
name: Build and upload sdist
12+
runs-on: ubuntu-latest
13+
defaults:
14+
run:
15+
shell: bash -l {0}
16+
17+
steps:
18+
- uses: actions/checkout@v2
19+
- uses: mamba-org/setup-micromamba@v1
20+
with:
21+
generate-run-shell: true
22+
environment-file: environment.yml
23+
create-args: >-
24+
python=3.10
25+
26+
- name: Install py-build
27+
run: |
28+
python3 -m pip install --upgrade build
29+
30+
- name: Build
31+
run: |
32+
python3 -m build --sdist --wheel --outdir dist/
33+
34+
- name: Publish Package
35+
uses: pypa/gh-action-pypi-publish@master
36+
with:
37+
user: __token__
38+
password: ${{ secrets.PYPI_API_TOKEN }}

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.idea/
2+
.tox/
3+
__pycache__
4+

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)