-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
55d2221
commit 5d5259a
Showing
29 changed files
with
3,574 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
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. | ||
|
||
**Code To Reproduce** | ||
CLI commands or Python code snippet to reproduce the bug | ||
|
||
```python | ||
``` | ||
|
||
**Output** | ||
Compete output obtained with maximal verbosity. | ||
|
||
**Environment:** | ||
- Python version: `python --version` | ||
- sertit-utils version: `import eoreader; eosets.__version__` | ||
|
||
**Additional context** | ||
Add any other context about the bug here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
contact_links: | ||
- name: Ask questions | ||
url: https://github.com/sertit/eosets/discussions/categories/q-a | ||
about: Please ask and answer questions here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
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 about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
### Your checklist for this pull request | ||
Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository. | ||
|
||
- [ ] Check the commit's or even all commits' message styles matches our requested structure. | ||
- [ ] Check your code additions will fail neither code linting checks nor unit test. | ||
|
||
### Description | ||
Please describe your pull request. | ||
|
||
### Further comments | ||
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... | ||
|
||
Thank you! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
name: Publish to PyPI | ||
|
||
on: | ||
push: | ||
tags: | ||
- "v*" | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build-n-publish: | ||
name: Build and publish to PyPI | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout source | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Python 3.9 | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: "3.9" | ||
|
||
- name: Check that the current version isn't already on PyPi | ||
run: | | ||
if [ "$(./get_pypi_latest_version.sh)" != "$(python setup.py --version)" ] | ||
then | ||
echo "Current version is not on PyPI, proceed with bulding" | ||
else | ||
echo "Current version is the latest version uploaded to PyPI" | ||
exit 1 | ||
fi | ||
- name: Build a binary wheel and a source tarball | ||
run: | | ||
python -m pip install setuptools wheel methodtools | ||
python setup.py sdist bdist_wheel | ||
- name: Publish distribution to PyPI | ||
uses: pypa/gh-action-pypi-publish@release/v1 | ||
with: | ||
user: ${{ secrets.PYPI_TOKEN }} | ||
password: ${{ secrets.PYPI_PWD }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: Mirror and run GitLab CI | ||
|
||
on: [ push ] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
- name: Mirror + trigger CI | ||
uses: SvanBoxel/gitlab-mirror-and-ci-action@master | ||
with: | ||
args: "https://${{ secrets.GITLAB_HOSTNAME }}/sertit/libraries/eosets" | ||
env: | ||
GITLAB_HOSTNAME: ${{ secrets.GITLAB_HOSTNAME }} | ||
GITLAB_USERNAME: ${{ secrets.GITLAB_USERNAME }} | ||
GITLAB_PASSWORD: ${{ secrets.GITLAB_PASSWORD }} | ||
GITLAB_PROJECT_ID: ${{ secrets.GITLAB_PROJECT_ID }} | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
# Release History | ||
# Release History | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for | ||
everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity | ||
and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, | ||
color, religion, or sexual identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take | ||
appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, | ||
issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for | ||
moderation decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing | ||
the community in public spaces. Examples of representing our community include using an official e-mail address, posting | ||
via an official social media account, or acting as an appointed representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible | ||
for enforcement at dev-sertit@unistra.fr. All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem | ||
in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the | ||
community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation | ||
and an explanation of why the behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including | ||
unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding | ||
interactions in community spaces as well as external channels like social media. Violating these terms may lead to a | ||
temporary or permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified | ||
period of time. No public or private interaction with the people involved, including unsolicited interaction with those | ||
enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate | ||
behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at | ||
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available | ||
at [https://www.contributor-covenant.org/translations][translations]. | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html | ||
|
||
[Mozilla CoC]: https://github.com/mozilla/diversity | ||
|
||
[FAQ]: https://www.contributor-covenant.org/faq | ||
|
||
[translations]: https://www.contributor-covenant.org/translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contribute | ||
|
||
## Report issues | ||
|
||
Issue tracker: https://github.com/sertit/eosets/issues | ||
|
||
Please check that a similar issue does not already exist and include the following information in your post: | ||
|
||
- Describe what you expected to happen. | ||
- If possible, include a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) | ||
to help us identify the issue. This also helps check that the issue is not with your own code. | ||
- Describe what actually happened. Include the full traceback if there was an exception. | ||
- List your Python and EOReader versions. | ||
If possible, check if this issue is already fixed in the latest releases or the latest code in the repository. | ||
|
||
## Submit patches | ||
|
||
If you intend to contribute to **EOSets** source code: | ||
|
||
``` | ||
conda env create -f environment.yml | ||
conda activate -n eosets | ||
pre-commit install | ||
``` | ||
|
||
or | ||
|
||
``` | ||
pip install -r requirements.txt | ||
pre-commit install | ||
``` | ||
|
||
Note that to run the documentation, you have to add this step: | ||
|
||
``` | ||
pip install -r requirements-doc.txt | ||
``` | ||
|
||
|
||
We use `pre-commit` to run a suite of linters, formatters and pre-commit hooks (`black`, `isort`, `flake8`) to | ||
ensure the code base is homogeneously formatted and easier to read. It's important that you install it, since we run the | ||
exact same hooks in the Continuous Integration. | ||
|
||
For now, you won't be able to run the test suite as we cannot provide an example of each product (some are licensed). We | ||
will take care of that for you. Please be sure that your code is running on Python 3.9+. | ||
|
||
## Release EOReader | ||
|
||
Releases are made by tagging a commit on the master branch. To make a new release, | ||
|
||
* Ensure you correctly updated `README.md` and `CHANGES.md` | ||
* Check that the version string in `eosets/__meta__.py` (the variable `__version__`) is correctly updated | ||
* Push your local master branch to remote. |
Oops, something went wrong.