Skip to content
This repository was archived by the owner on Sep 9, 2024. It is now read-only.

Commit 797e2a6

Browse files
rivermamike-ganglanilnatha
authored
Added missing files and improved README (#55)
Co-authored-by: mike-gangl <59702631+mike-gangl@users.noreply.github.com> Co-authored-by: Anil Natha <anilnatha@users.noreply.github.com>
1 parent fccb285 commit 797e2a6

File tree

4 files changed

+177
-34
lines changed

4 files changed

+177
-34
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: '[Bug]: '
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Checked for duplicates**
11+
12+
> Have you checked for duplicate issue tickets?
13+
14+
- Ex. Yes - I've already checked
15+
- Ex. No - I haven't checked
16+
17+
**Describe the bug**
18+
19+
> A clear and concise description of what the bug is. Plain-text snippets preferred but screenshots welcome.
20+
21+
Ex. When I did [...] action, I noticed [...]
22+
23+
**What did you expect?**
24+
25+
> A clear and concise description of what you expect to happen
26+
27+
Ex. I expected [...]
28+
29+
**Reproducible steps**
30+
31+
> How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets preferred but screenshots welcome.
32+
33+
1.
34+
2.
35+
3.
36+
37+
**What is your environment?**
38+
39+
> Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue
40+
41+
- Ex. Version of this software [e.g. vX.Y.Z]
42+
- Ex. Operating System: [e.g. MacOSX with Docker Desktop vX.Y]
43+
- ...

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: New Feature
3+
about: Suggest a new feature for us to implement
4+
title: '[New Feature]: '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Checked for duplicates**
11+
12+
> Have you checked for duplicate issue tickets?
13+
14+
- Ex. Yes - I've already checked
15+
- Ex. No - I haven't checked
16+
17+
**Alternatives considered**
18+
19+
> Have you considered alternative solutions to your feature request?
20+
21+
- Ex. Yes - and alternatives don't suffice
22+
- Ex. No - I haven't considered
23+
24+
**Related problems**
25+
26+
> Is your feature request related to any problems? Please help us understand if so, including linking to any other issue tickets.
27+
28+
Ex. I'm frustrated when [...] happens as documented in issue-XYZ
29+
30+
**Describe the feature request**
31+
32+
> A clear and concise description of your request.
33+
34+
Ex. I need or want [...]

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Purpose
2+
- Clear, easy-to-understand sentences outlining the purpose of the PR
3+
## Proposed Changes
4+
- [ADD] ...
5+
- [CHANGE] ...
6+
- [FIX] ...
7+
## Issues
8+
- Links to relevant issues
9+
- Example: issue-XYZ
10+
## Testing
11+
- Provide some proof you've tested your changes
12+
- Example: test results available at ...
13+
- Example: tested on operating system ...

‎README.md‎

Lines changed: 87 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,72 @@
1-
# Unity-Py
21

3-
Unity-Py is a Python client to simplify interactions with NASA's Unity Platform.
2+
<hr>
43

5-
## Installation
4+
<div align="center">
65

7-
### Install from pypi
8-
```
9-
pip install unity-sds-client
10-
```
6+
![logo](https://user-images.githubusercontent.com/3129134/163255685-857aa780-880f-4c09-b08c-4b53bf4af54d.png)
117

12-
### Install from Github
13-
```
14-
python -m pip install git+https://github.com/unity-sds/unity-py.git
15-
```
8+
<h1 align="center">Unity-Py</h1>
169

17-
### Building and installing locally using poetry
10+
</div>
1811

19-
```
20-
git clone https://github.com/unity-sds/unity-py.git
21-
cd unity-py
22-
poetry install
23-
```
12+
<pre align="center">A Python client to simplify interactions with NASA's Unity Platform.</pre>
2413

25-
## Getting Started
14+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) [![SLIM](https://img.shields.io/badge/Best%20Practices%20from-SLIM-blue)](https://nasa-ammos.github.io/slim/)
2615

27-
### Authorization
16+
[INSERT SCREENSHOT OF YOUR SOFTWARE, IF APPLICABLE]
2817

29-
Authorization can be handled interactively, in which case you will be prompted for a username/password when calling the Unity() method, or can be handled by way of environment variables:
18+
Unity-Py provides a seamless way to interact with NASA's Unity Platform using Python. Built to simplify the connection and data retrieval process, this client offers a programmatic interface to Unity's services.
19+
20+
## Features
21+
22+
* Pythonic interface to NASA's Unity Platform
23+
* Support for interactive and environment variable-based authorization
24+
25+
## Contents
26+
27+
* [Quick Start](#quick-start)
28+
* [Changelog](#changelog)
29+
* [FAQ](#frequently-asked-questions-faq)
30+
* [Contributing Guide](#contributing)
31+
* [License](#license)
32+
* [Support](#support)
33+
34+
## Quick Start
35+
36+
### Requirements
37+
38+
* Python
39+
* pip
40+
41+
### Setup Instructions
42+
43+
1. Install via pypi:
44+
```
45+
pip install unity-sds-client
46+
```
47+
2. Install from Github:
48+
```
49+
python -m pip install git+https://github.com/unity-sds/unity-py.git
50+
```
51+
3. Building and installing locally using poetry:
52+
```
53+
git clone https://github.com/unity-sds/unity-py.git
54+
cd unity-py
55+
poetry install
56+
```
57+
58+
### Run Instructions
3059

60+
Authorization can be handled interactively, in which case you will be prompted for a username/password when calling the Unity() method, or can be handled by way of environment variables:
3161
```
3262
export UNITY_USER=MY_UNITY_USERNAME
3363
export UNITY_PASSWORD=MY_UNITY_PASSWORD
3464
```
35-
36-
The order of Authentication Parameters is as follows:
37-
65+
Order of Authentication Parameters:
3866
1. Environment variables
3967
2. Prompt for username and password
4068

41-
### Running your first command
69+
### Usage Examples
4270

4371
```
4472
from unity_sds_client.unity import Unity
@@ -54,19 +82,44 @@ cd = dataManager.get_collection_data(collections[0])
5482
for dataset in cd:
5583
print(f'dataset name: {dataset.id}' )
5684
for f in dataset.datafiles:
57-
print("\t" + f.location)
85+
print(" " + f.location)
5886
```
5987

60-
## Testing
61-
To run unit and regression tests:
88+
### Test Instructions
6289

63-
```
64-
# run all tests and include printouts:
65-
poetry run pytest -s
90+
1. Run all tests and include printouts:
91+
```
92+
poetry run pytest -s
93+
```
6694

67-
# run non-regression tests:
68-
poetry run pytest -m "not regression"
95+
2. Run non-regression tests:
96+
```
97+
poetry run pytest -m "not regression"
98+
```
6999

70-
# run regression tests (and include logs)
100+
3. Run regression tests (and include logs)
101+
```
102+
(Not Available Yet)
103+
```
71104

72-
```
105+
## Changelog
106+
107+
See our [CHANGELOG.md](CHANGELOG.md) for a history of our changes.
108+
109+
See our [releases page](https://github.com/unity-sds/unity-py/releases) for our key versioned releases.
110+
111+
## Frequently Asked Questions (FAQ)
112+
113+
No questions yet. Propose a question to be added here by reaching out to our contributors! See support section below.
114+
115+
## Contributing
116+
117+
Interested in contributing to our project? Please see our: [CONTRIBUTING.md](CONTRIBUTING.md)
118+
119+
## License
120+
121+
See our: [LICENSE](LICENSE)
122+
123+
## Support
124+
125+
Please reach out to [@anilnatha](https://github.com/anilnatha), [@mike-gangl](https://github.com/mike-gangl)

0 commit comments

Comments
 (0)