Skip to content

Commit

Permalink
Update package settings and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiggi committed Apr 6, 2024
1 parent 8715107 commit 8f35a7e
Show file tree
Hide file tree
Showing 46 changed files with 1,860 additions and 854 deletions.
13 changes: 13 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[run]
source =
tstore
omit =
*docs*
*tutorials*
tstore/_version.py

[report]
exclude_lines =
pragma: no cover
def __repr__
def __str__
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🐞 Bug Report
description: File a bug/issue
title: "[BUG] <title>"
labels: [bug, triage]
assignees: ghiggi
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Python**: 3.8.2
value: |
- OS:
- python:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: ➕ Feature request
about: Suggest an idea for this project
title: ''
description: What is your feature request ?
title: "[FEATURE] <title>"
labels: [enhancement, triage]
assignees: ghiggi

---

**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. Please explain why and how it helps your users.

**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.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: 🐢 Performance
about: "Runtime, memory, speed, or storage inefficiency"
title: ""
labels: "topic: performance"
assignees: ghiggi
---

## Prework

- [ ] Read and agree to the [code of conduct](https://github.com/ltelab/tstore/blob/main/CODE_OF_CONDUCT.md).
- [ ] If there is [already a relevant issue](https://github.com/ltelab/tstore/issues), whether open or closed, comment on the existing thread instead of posting a new issue.
- [ ] Post a minimal reproducible example so the maintainer can troubleshoot the problems you identify. A reproducible example is:
- [ ] **Runnable**
- [ ] **Minimal**: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.

## Description

Please describe the performance issue.

## Benchmarks

How poorly does TStore perform?
60 changes: 60 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Prework

- [ ] I understand and agree to this repository's [code of conduct](https://github.com/ltelab/tstore/blob/main/CODE_OF_CONDUCT.md).
- [ ] I understand and agree to this repository's [contributing guidelines](https://github.com/ltelab/tstore/blob/main/CONTRIBUTING.md).
- [ ] I have already submitted an [issue](https://github.com/ltelab/tstore/issues) or [discussion thread](https://github.com/ltelab/tstore/discussions) to discuss my idea with the maintainers.

<!--
Please make sure to read the Pull Request Guidelines:
https://github.com/ltelab/tstore/blob/main/CONTRIBUTING.md#pull-request-guidelines
-->

<!-- PULL REQUEST TEMPLATE -->

<!-- (Update "[ ]" to "[x]" to check a box) -->

**What kind of change does this PR introduce?** (check at least one)

- [ ] Bugfix
- [ ] Feature
- [ ] Documentation
- [ ] Tutorial
- [ ] Code style update
- [ ] Refactor
- [ ] Build-related changes
- [ ] Other, please describe:

**Does this PR introduce a breaking change?** (check one)

- [ ] Yes
- [ ] No

If yes, please describe the impact and communicate accordingly:

**The PR fulfills these requirements:**

- [ ] It's submitted to the branch named as follow:
- Fix a bug: `bugfix-<some_key>-<word>`
- Improve the doc: `doc-<some_key>-<word>`
- Improve a tutorial `tutorial-<some_key>-<word>`
- Add a new feature: `feature-<some_key>-<word>`
- Refactor some code: `refactor-<some_key>-<word>`
- Optimize some code: `optimize-<some_key>-<word>`
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
- [ ] Don't forget to link PR to issue if you are solving one.
- [ ] All tests are passing.
- [ ] New/updated tests are included

If adding a **new feature**, the PR's description includes:

- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

**Other information:**

# Related GitHub issues and pull requests

- Ref: #

# Summary

Please explain the purpose and scope of your contribution.
11 changes: 0 additions & 11 deletions .github/dependabot.yaml

This file was deleted.

11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -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://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "github-actions" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "monthly"
31 changes: 0 additions & 31 deletions .github/workflows/ci.yaml

This file was deleted.

24 changes: 0 additions & 24 deletions .github/workflows/lint.yaml

This file was deleted.

36 changes: 36 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Lint
on: [push, pull_request, workflow_dispatch]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: "3.8"

- name: Ruff
if: success() || failure()
uses: pre-commit/[email protected]
with:
extra_args: ruff --all-files

- name: Black
if: success() || failure()
uses: pre-commit/[email protected]
with:
extra_args: black --all-files

- name: blackdoc
if: success() || failure()
uses: pre-commit/[email protected]
with:
extra_args: blackdoc --all-files

- name: codespell
if: success() || failure()
uses: pre-commit/[email protected]
with:
extra_args: codespell --all-files
56 changes: 56 additions & 0 deletions .github/workflows/release_to_pypi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Package Release to PyPI
on:
push:
tags:
- "v*"

jobs:
build-n-publish:
name: Build and publish to PyPI
runs-on: ubuntu-latest
permissions:
contents: write

steps:
- name: Checkout source
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"

- name: Install pypa/build
run: >-
python -m
pip install build
- name: Build a binary wheel
run: >-
python -m build
- name: Publish distribution to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}

- name: Get Asset name
if: success() || failure()
run: |
export PKG=$(ls dist/ | grep tar)
set -- $PKG
echo "asset_name=$1" >> $GITHUB_ENV
- name: Create GitHub Release
if: success() || failure()
id: create_release
uses: softprops/action-gh-release@v2
with:
name: ${{ github.ref }}
tag_name: ${{ github.ref }}
files: |
dist/${{ env.asset_name }}
draft: false
prerelease: false
token: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
Loading

0 comments on commit 8f35a7e

Please sign in to comment.