Skip to content

Commit 08101e7

Browse files
committed
Remove setup.cfg, doesn't seem to add enough value
update readme
1 parent e09b13c commit 08101e7

File tree

3 files changed

+27
-50
lines changed

3 files changed

+27
-50
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ jobs:
2121
run: pip install -r requirements.txt
2222

2323
- name: Test
24-
run: python setup.py test
24+
run: python setup.py pytest

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,29 @@ This is an example repository for writing tests, for the Sciware Testing session
66
It demonstrates how to setup a repository to use GitHub actions to automatically run tests
77
on the code.
88

9-
**.github/workflows/** - Directory containing the configuration file for GitHub actions.
10-
11-
**`.github/workflows/test.yml`** - File detailing the system configurations to use for the tests.
12-
13-
**sciware_testing_python/** - Directory for all the code.
14-
15-
**`sciware_testing_python/__init.py__`** - File telling Python that there are executable files in this directory.
16-
17-
**`sciware_testing_python/sciware_testing_python.py`** - File with all of the code.
18-
19-
**tests/** - Directory for the code which tests the code in `sciware_testing_python`.
20-
21-
**`tests/test_sciware_testing_python.py`** - File containing the tests.
22-
23-
**.gitignore** - File which tells github what files to not track (optional)
24-
25-
**LICENSE** - File containing the text of the license the code is released under. Having a license file allows other people to use the code.
26-
27-
**README.md** - File generating this page.
28-
29-
**requirements.txt** - File listing the packages required to run the code. It is used to configure
30-
GitHub actions to automatically test the code.
31-
32-
**setup.cfg** - File...
33-
34-
**setup.py** - File..
9+
## Quick-start
10+
11+
### Test
12+
13+
```bash
14+
git clone https://github.com/flatironinstitute/sciware-testing-python.git
15+
cd sciware-testing-python
16+
python3 ./setup.py pytest
17+
```
18+
19+
## Forking This Project
20+
21+
## Contents
22+
23+
* **`.github/workflows/`** - Directory containing the configuration file for GitHub actions.
24+
* **`.github/workflows/test.yml`** - File detailing the system configurations to use for the tests.
25+
* **sciware_testing_python/** - Directory for all the code.
26+
* **`sciware_testing_python/__init.py__`** - File telling Python what to import with `sciware_testing_python` package.
27+
* **`sciware_testing_python/sciware_testing_python.py`** - File with all of the code.
28+
* **`tests/`** - Directory for the code which tests the code in `sciware_testing_python`.
29+
* **`tests/test_sciware_testing_python.py`** - File containing the tests.
30+
* **`.gitignore`** - File which tells github what files to not track (optional)
31+
* **`LICENSE`** - File containing the text of the license the code is released under. Having a license file allows other people to use the code.
32+
* **`README.md`** - File generating this page.
33+
* **`requirements.txt`** - File listing the packages required to run the code. It is included by setup.py.
34+
* **setup.py** - File describing the metadata for the package and rules to build/install/test it.

setup.cfg

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)