diff options
Diffstat (limited to '.github')
-rw-r--r-- | .github/FUNDING.yml | 4 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 28 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 20 | ||||
-rw-r--r-- | .github/dependabot.yml | 11 | ||||
-rw-r--r-- | .github/workflows/pythonpackage.yml | 45 |
5 files changed, 108 insertions, 0 deletions
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..2d92677 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,4 @@ +# These are supported funding model platforms + +github: willmcgugan +custom: https://www.willmcgugan.com/sponsorship/ diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..6bbe40a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,28 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: Needs triage +assignees: "" +--- + +**Read the docs** +You might find a solution to your problem in the [docs](https://rich.readthedocs.io/en/latest/introduction.html) -- consider using the search function there. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +A minimal code example that reproduces the problem would be a big help if you can provide it. If the issue is visual in nature, consider posting a screenshot. + +**Platform** +What platform (Win/Linux/Mac) are you running on? What terminal software are you using? + +**Diagnose** +I may ask you to cut and paste the output of the following commands. It may save some time if you do it now. + +``` +python -m rich.diagnose +python -m rich._windows +pip freeze | grep rich +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..ab4de71 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[REQUEST]" +labels: Needs triage +assignees: '' + +--- + +Consider posting in https://github.com/willmcgugan/rich/discussions for feedback before raising a feature request. + +Have you checked the issues for a similar suggestions? + +**How would you improve Rich?** + +Give as much detail as you can. Example code of how you would like it to work would help. + +**What problem does it solved for you?** + +What problem do you have that this feature would solve? I may be able to suggest an existing way of solving it. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..cf7a39f --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "pip" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "daily" diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml new file mode 100644 index 0000000..9685a6f --- /dev/null +++ b/.github/workflows/pythonpackage.yml @@ -0,0 +1,45 @@ +name: Test Rich module + +on: [pull_request] + +jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [windows-latest, ubuntu-latest, macos-latest] + python-version: [3.6, 3.7, 3.8, 3.9] + defaults: + run: + shell: bash + steps: + - uses: actions/checkout@v1 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + architecture: x64 + - name: Install and configure Poetry + uses: snok/install-poetry@v1.1.1 + with: + version: 1.1.4 + virtualenvs-create: false + - name: Install dependencies + run: poetry install + if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' + - name: Format check with black + run: make format-check + - name: Typecheck with mypy + run: make typecheck + - name: Test with pytest + run: | + pip install . + python -m pytest tests -v --cov=./rich --cov-report=xml:./coverage.xml --cov-report term-missing + - name: Upload code coverage + uses: codecov/codecov-action@v1.0.10 + with: + token: ${{ secrets.CODECOV_TOKEN }} + file: ./coverage.xml + name: rich + flags: unittests + env_vars: OS,PYTHON |