Skip to content
Permalink
Browse files

Cleanup Python project

  • Loading branch information
timofurrer committed Aug 24, 2019
1 parent 260f0d5 commit a4432eef3199c5e8d1e9d9609ae469ebfcf632a1
@@ -0,0 +1,12 @@
[run]
branch = True
source =
maya

[paths]
source =
src
.tox/*/site-packages

[report]
show_missing = True
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at tuxtimo@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
@@ -0,0 +1,45 @@
# Contributing

Thank you for helping maya to get a better piece of software.

## Support

If you have any questions regarding the usage of maya please use the Question Issue Template or ask on [StackOverflow](https://stackoverflow.com).

## Reporting Issues / Proposing Features

Before you submit an Issue or proposing a Feature check the existing Issues in order to avoid duplicates. <br>
Please make sure you provide enough information to work on your submitted Issue or proposed Feature:

* Which version of maya are you using?
* Which version of python are you using?
* On which platform are you running maya?

Make sure to use the GitHub Template when reporting an issue.

## Pull Requests

We are very happy to receive Pull Requests considering:

* Style Guide. Follow the rules of [PEP8](http://legacy.python.org/dev/peps/pep-0008/), but you may ignore *too-long-lines* and similar warnings. There is a *pylintrc* file for more information.
* Tests. If our change affects python code inside the source code directory, please make sure your code is covered by an automated test case.

### Testing

To test the maya source code against all supported python versions you should use *tox*:

```bash
cd ~/work/maya
pip install tox
tox
```

However, if you want to test your code on certain circumstances you can create a *virtualenv*:

```
cd ~/work/maya
virtualenv env
source env/bin/activate
pip install -e '.[dev]'
commands = coverage run --parallel -m pytest -s --failed-first
```
@@ -0,0 +1,42 @@
---
name: Bug Report
about: Create a bug report to help us improve maya
title: ''
labels: ''
assignees: ''

---

**Important notices**
Before you add a new report, we ask you kindly to acknowledge the following:

[-] I have read the contributing guide lines at https://github.com/timofurrer/maya/blob/master/.github/CONTRIBUTING.md

[-] I have read and respect the code of conduct at https://github.com/timofurrer/maya/blob/master/.github/CODE_OF_CONDUCT.md

[-] I have searched the existing issues and I'm convinced that mine is new.

**Describe the bug**
A clear and concise description of what the bug is.

**Environment and Version**
* OS (incl. terminal and shell used): ...
* Python Version: ...
* maya Version: ...
* Your timezone: ...

**To Reproduce**
A clear and concise description of steps to reproduce the behavior
you are experiencing.

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

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Relevant log files**
If applicable, information from log files supporting your claim.

**Additional context**
Add any other context about the problem here.
@@ -0,0 +1,29 @@
---
name: Feature Request
about: Suggest an idea for a new feature or enhancement for maya
title: ''
labels: ''
assignees: ''

---

**Important notices**
Before you add a new request, we ask you kindly to acknowledge the following:

[-] I have read the contributing guide lines at https://github.com/timofurrer/maya/blob/master/.github/CONTRIBUTING.md

[-] I have read and respect the code of conduct at https://github.com/timofurrer/maya/blob/master/.github/CODE_OF_CONDUCT.md

[-] I have searched the existing issues and I'm convinced that mine is new.

**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.
@@ -0,0 +1,20 @@
---
name: Ask a Question
about: Ask a Question about maya (Usage, Development, ...)
title: ''
labels: ''
assignees: ''

---

**Important notices**
Before you add a new report, we ask you kindly to acknowledge the following:

[-] I have read the contributing guide lines at https://github.com/timofurrer/maya/blob/master/.github/CONTRIBUTING.md

[-] I have read and respect the code of conduct at https://github.com/timofurrer/maya/blob/master/.github/CODE_OF_CONDUCT.md

[-] I have searched the existing issues and I'm convinced that mine is new.

**Ask your Question**
Ask your question here! If the question is related to a particular environment or behavior please make sure to add some context.
@@ -0,0 +1,82 @@
name: Continuous Integration and Deployment

on: [push]

jobs:
build:

runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
max-parallel: 4
matrix:
python-version: [2.7, 3.5, 3.6, 3.7]
os: [ubuntu-latest, windows-latest, macOS-latest]

steps:
- uses: actions/checkout@v1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Setup build and test environment
run: |
python -m pip install --upgrade pip setuptools wheel
- name: Build Python Package
run: |
python -m pip install ".[tests]"
- name: Lint with flake8
run: |
pip install flake8
flake8 --show-source src/ tests/
- name: Check Manifest
run: |
pip install check-manifest
check-manifest
- name: Test with pytest
run: |
coverage run --parallel -m pytest
- name: Report code coverage
run: |
coverage combine
coverage report
coverage xml
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
- name: Set up Python 3.7
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Setup docs environment
run: |
python -m pip install ".[docs]"
- name: Build documentation with sphinx
run: |
sphinx-build -W -b html -d doctrees docs/source docs/_build/html
publish:
needs: [build, docs]
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
- name: Set up Python 3.7
if: startsWith(github.event.ref, 'refs/tags')
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Build Package
if: startsWith(github.event.ref, 'refs/tags')
run: |
python -m pip install --upgrade pip setuptools wheel
python setup.py sdist bdist_wheel --universal
- name: Publish Package on PyPI
if: startsWith(github.event.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@master
with:
user: __token__
password: ${{ secrets.pypi_token }}
@@ -0,0 +1,18 @@
name: "Close Stale Issues and Pull Requests"
on:
schedule:
- cron: "0 * * * *"

jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
days-before-stale: 60
days-before-close: 7
stale-issue-label: stale
stale-pr-label: state
stale-issue-message: 'This Issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days'
stale-pr-message: 'This Pull Request is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days'
@@ -0,0 +1,32 @@
repos:
- repo: https://github.com/ambv/black
rev: 19.3b0
hooks:
- id: black
language_version: python3.7
# override until resolved: https://github.com/ambv/black/issues/402
files: \.pyi?$
types: []

- repo: https://gitlab.com/pycqa/flake8
rev: 3.7.7
hooks:
- id: flake8
language_version: python3.7

#- repo: https://github.com/asottile/seed-isort-config
#rev: v1.9.1
#hooks:
#- id: seed-isort-config

#- repo: https://github.com/pre-commit/mirrors-isort
#rev: v4.3.20
#hooks:
#- id: isort
#language_version: python3.7

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.2.3
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer

This file was deleted.

This file was deleted.

0 comments on commit a4432ee

Please sign in to comment.
You can’t perform that action at this time.