Skip to content

Commit

Permalink
chore: Restructure project with copier template
Browse files Browse the repository at this point in the history
  • Loading branch information
georgedouzas committed Dec 2, 2023
1 parent 0956d77 commit 73b3280
Show file tree
Hide file tree
Showing 79 changed files with 2,224 additions and 2,954 deletions.
18 changes: 18 additions & 0 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
_commit: 0.8.0
_src_path: gh:georgedouzas/copier-pdm-nox.git
author_email: [email protected]
author_fullname: Georgios Douzas
author_username: georgedouzas
copyright_date: '2019'
copyright_holder: Georgios Douzas
copyright_holder_email: [email protected]
copyright_license: MIT License
project_description: Implementation of the Geometric SMOTE algorithm, a geometrically
enhanced drop-in replacement for SMOTE. It is compatible with scikit-learn and
imbalanced-learn.
python_package_distribution_name: geometric-smote
python_package_import_name: gsmote
python_versions: '>=3.9, <3.12'
repository_name: geometric-smote
repository_namespace: georgedouzas

21 changes: 0 additions & 21 deletions .coveragerc

This file was deleted.

2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github:
- georgedouzas
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Bug report
description: Create a report to help us reproduce and correct the bug.
labels: ['fix']

body:
- type: markdown
attributes:
value: >
**Before submitting a bug, please make sure the issue hasn't been already addressed by searching
through [the past issues](https://github.com/georgedouzas/geometric-smote/issues).**
- type: textarea
attributes:
label: Describe the bug
description: >
A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Steps or code to reproduce the bug
description: |
Please add a minimal code example that can reproduce the error when running it.
If the code is too long, feel free to put it in a public gist and link it in the issue.
placeholder: |
```
Sample code to reproduce the problem
```
validations:
required: true
- type: textarea
attributes:
label: Expected Results
description: >
Please paste or describe the expected results.
placeholder: >
Example: No error is thrown.
validations:
required: true
- type: textarea
attributes:
label: Actual Results
description: |
Please paste or describe the results you observe instead of the expected results. If you observe an error, please paste
the error message including the **full traceback** of the exception.
placeholder: >
Please paste or specifically describe the actual output or traceback.
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
Please provide the following information.
placeholder: >
`geometric-smote` version
Python version
OS
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing!
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Discussions
url: https://github.com/georgedouzas/geometric-smote/discussions
about: Ask questions and discuss with other community members
- name: Gitter
url: https://gitter.im/geometric-smote/community
about: Users and developers can sometimes be found on the gitter channel
- name: Blank issue
url: https://github.com/georgedouzas/geometric-smote/issues/new
about: Please note that Github Discussions should be used in most cases instead
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature request
description: Suggest a new algorithm, enhancement to an existing algorithm, etc.
labels: ['feat']

body:
- type: textarea
attributes:
label: Describe the new feature you propose to be implemented
validations:
required: true
- type: textarea
attributes:
label: Describe your proposed solution
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you have considered, if relevant
- type: textarea
attributes:
label: Additional context
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Pull Request Guide

## Checklist

Please check the following:

- [ ] You have checked the [Pull Request guidelines](https://github.com/georgedouzas/geometric-smote/blob/master/.github/CONTRIBUTING.md).
- [ ] Tests for bug fixes or new features have been added.
- [ ] Docs have been added or updated.

## Type

What kind of change does this Pull Request introduce?

- [ ] feat: New feature implementation.
- [ ] fix: Bug fix.
- [ ] docs: Documentation changes.
- [ ] style: Code style or format changes.
- [ ] refactor: Changes that are not features or bug fixes.
- [ ] tests: Test additions or corrections.
- [ ] chore: Maintenance code changes.
- [ ] other

## Current behaviour

Describe the current behaviour or provide a link to an issue.

## What is the new behavior?

Describe the new behaviour.

## Does this Pull Request introduce a breaking change?

- [ ] Yes
- [ ] No

## Other information

Provide any other information.
111 changes: 111 additions & 0 deletions .github/workflows/ci-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
name: CI and documentation

on:
push:
branches-ignore:
- main
workflow_dispatch:

jobs:

checks:

strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest

runs-on: ${{ matrix.os }}

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install Python versions
uses: actions/setup-python@v4
with:
python-version: |
3.9
3.10
3.11
- name: Set up PDM
uses: pdm-project/setup-pdm@v3
with:
cache: true
cache-dependency-path: pyproject.toml

- name: Install dependencies
run: pdm install --no-default -dG maintenance -dG checks

- name: Check code quality
run: pdm checks quality

- name: Check type annotations
run: pdm checks types

- name: Check vulnerabilities in dependencies
run: pdm checks dependencies

tests:

strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest

runs-on: ${{ matrix.os }}

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install Python versions
uses: actions/setup-python@v4
with:
python-version: |
3.9
3.10
3.11
- name: Set up PDM
uses: pdm-project/setup-pdm@v3
with:
cache: true
cache-dependency-path: pyproject.toml

- name: Install dependencies
run: pdm install -dG maintenance -dG tests

- name: Run the test suite
run: pdm tests

doc:

runs-on: ubuntu-latest

strategy:
matrix:
python-version: ['3.9', '3.10', '3.11']

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Set up PDM
uses: pdm-project/setup-pdm@v3
with:
cache: true
cache-dependency-path: pyproject.toml

- name: Install dependencies
run: pdm install -dG maintenance -dG docs

- name: Build documentation with Python ${{ matrix.python-version }}
run: pdm docs build
Loading

0 comments on commit 73b3280

Please sign in to comment.