Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release of SLIM Python Starterkit Sample Project #8

Merged
merged 30 commits into from
Jan 31, 2023
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
7e40603
NASA-AMMOS/slim#46: Initial template repository.
jpl-jengelke Nov 15, 2022
c1ecf20
Proposed CHANGELOG.md file format
riverma Nov 17, 2022
e50d00c
Proposed CODE_OF_CONDUCT.md file
riverma Nov 17, 2022
3f48927
Proposed CONTRIBUTING.md file / template
riverma Nov 17, 2022
fefe1bd
Proposed bug report, feature request, and pull request template forms
riverma Nov 17, 2022
d0ea930
Proposed license text with JPL/Caltech attribution
riverma Nov 17, 2022
30c3999
Proposed README.md file / template
riverma Nov 17, 2022
7e3efeb
Merge pull request #2 from NASA-AMMOS/riverma-oss-changelog
jpl-jengelke Nov 28, 2022
7980707
Merge pull request #3 from NASA-AMMOS/riverma-oss-code-of-conduct
jpl-jengelke Nov 28, 2022
84667e8
Merge pull request #5 from NASA-AMMOS/riverma-github-templates
jpl-jengelke Nov 28, 2022
7be958c
Merge pull request #6 from NASA-AMMOS/riverma-oss-license
jpl-jengelke Nov 28, 2022
59cc508
NASA-AMMOS/slim#46: Update README with build, release and publish ins…
jpl-jengelke Dec 1, 2022
2472f0b
NASA-AMMOS/slim#46: Update CONTRIBUTING with Python-specific instruct…
jpl-jengelke Dec 1, 2022
a4b3da6
Merge pull request #4 from NASA-AMMOS/riverma-oss-contributing-guide
jpl-jengelke Dec 1, 2022
f88fe4a
NASA-AMMOS/slim#46: Update README to address pull request comments. ...
jpl-jengelke Dec 5, 2022
77ee809
Merge pull request #7 from NASA-AMMOS/riverma-readme
jpl-jengelke Dec 5, 2022
a4687c5
NASA-AMMOS/slim#46: Various updates in support of starterkit improvem…
jpl-jengelke Dec 6, 2022
f419670
NASA-AMMOS/slim#46: Minor edits to improve README readability. ...
jpl-jengelke Dec 8, 2022
0a102fc
NASA-AMMOS/slim#46: Module naming appropriately abbreviated in setup …
jpl-jengelke Dec 8, 2022
d133ca8
NASA-AMMOS/slim#46: Moved module to reserved name. ...
jpl-jengelke Dec 8, 2022
1aee86c
NASA-AMMOS/slim#46: Formatted local workstation installation command.…
jpl-jengelke Dec 8, 2022
7b6e190
NASA-AMMOS/slim#46: Update dependabot to use required repo default br…
jpl-jengelke Dec 8, 2022
8d39fbf
NASA-AMMOS/slim#46: Rev prototype version. ...
jpl-jengelke Dec 8, 2022
63ef9f6
NASA-AMMOS/slim#46: Rename to slim_sample_project and reset release v…
jpl-jengelke Dec 14, 2022
9946256
NASA-AMMOS/slim#46: Update to release version anticipated on next mer…
jpl-jengelke Dec 14, 2022
0f427d6
NASA-AMMOS/slim#46: Organize, group and mark up sections that must be…
jpl-jengelke Dec 15, 2022
221653f
Merge branch 'slim_issue_46' into develop
jpl-jengelke Dec 15, 2022
372ca4d
NASA-AMMOS/slim#44: Remove obsoleted 'AUTHORS.md' file. ...
jpl-jengelke Dec 20, 2022
f45ade4
NASA-AMMOS/slim#46: Move required versioning tooling into its own imp…
jpl-jengelke Jan 4, 2023
ead3b6d
NASA-AMMOS/slim#46: Reorganized setup.cfg to condense all user moddif…
jpl-jengelke Jan 6, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug Report
about: Report a bug to help us improve
title: '[Bug]: '
labels: 'bug'
assignees: ''

---

**Checked for duplicates**

> Have you checked for duplicate issue tickets?

- Ex. Yes - I've already checked
- Ex. No - I haven't checked

**Describe the bug**

> A clear and concise description of what the bug is. Plain-text snippets preferred but screenshots welcome.

Ex. When I did [...] action, I noticed [...]

**What did you expect?**

> A clear and concise description of what you expect to happen

Ex. I expected [...]

**Reproducible steps**

> How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets preferred but screenshots welcome.

1.
2.
3.

**What is your environment?**

> Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue

- Ex. Version of this software [e.g. vX.Y.Z]
- Ex. Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
- ...
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: New Feature
about: Suggest a new feature for us to implement
title: '[New Feature]: '
labels: 'enhancement'
assignees: ''

---

**Checked for duplicates**

> Have you checked for duplicate issue tickets?

- Ex. Yes - I've already checked
- Ex. No - I haven't checked

**Alternatives considered**

> Have you considered alternative solutions to your feature request?

- Ex. Yes - and alternatives don't suffice
- Ex. No - I haven't considered

**Related problems**

> Is your feature request related to any problems? Please help us understand if so, including linking to any other issue tickets.

Ex. I'm frustrated when [...] happens as documented in issue-XYZ

**Describe the feature request**

> A clear and concise description of your request.

Ex. I need or want [...]
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Purpose
- Clear, easy-to-understand sentences outlining the purpose of the PR
## Proposed Changes
- [ADD] ...
- [CHANGE] ...
- [FIX] ...
## Issues
- Links to relevant issues
- Example: issue-XYZ
## Testing
- Provide some proof you've tested your changes
- Example: test results available at ...
- Example: tested on operating system ...
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: 'pip'
directory: '/' # location of package manifests
schedule:
interval: 'daily'
time: '09:00'
timezone: 'America/Los_Angeles'
target-branch: 'main'
labels:
- 'dependencies'
38 changes: 38 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# This workflows will upload a Python Package using Twine when a release is created
# For more information see:
# https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries

name: Upload Python Package

on:
release:
types: [published]
branches: [main]

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Upgrade tooling
run: |
python3 -m pip install --upgrade pip
pip3 install --upgrade build setuptools setuptools_scm[toml] twine wheel
- name: Build package
run: |
python3 -m build --wheel
python3 setup.py sdist --format=zip
- name: Publish package
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
jpl-jengelke marked this conversation as resolved.
Show resolved Hide resolved
run: |
twine check dist/*
twine upload --repository testpypi --verbose dist/*.whl dist/*.zip
22 changes: 11 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ __pycache__/

# Distribution / packaging
.Python
bin/
build/
develop-eggs/
dist/
Expand Down Expand Up @@ -84,17 +85,7 @@ ipython_config.py
# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
# celery beat schedule file
celerybeat-schedule
celerybeat.pid

Expand Down Expand Up @@ -127,3 +118,12 @@ dmypy.json

# Pyre type checker
.pyre/

# os / system / installation files
**/.DS_Store
**/installers/
*.swp

# IDE
.idea
**/Pipfile*
4 changes: 4 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Authors
jpl-jengelke marked this conversation as resolved.
Show resolved Hide resolved

## Coding Contributors
- [John Engelke](https://github.com/jpl-jengelke)
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2022-01-01

### Added

-
-
-
3 changes: 3 additions & 0 deletions CITATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Citation

If you use any of these algorithms in your work, please directly cite this repository.
131 changes: 131 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# 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 (see contact links): [INSERT CONTACT METHOD].
jpl-jengelke marked this conversation as resolved.
Show resolved Hide resolved
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.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

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.1]: https://www.contributor-covenant.org/version/2/1/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
Loading