Skip to content

Commit 56e3d13

Browse files
committed
Improve local development instructions in README
1 parent 32452be commit 56e3d13

1 file changed

Lines changed: 22 additions & 9 deletions

File tree

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -122,39 +122,52 @@ from xocto import localtime
122122

123123
See [xocto.localtime](xocto/localtime.py) for more details, including examples and in depth technical details.
124124

125-
## Contributing
125+
## Development
126126

127-
Create and activate a virtualenv then:
127+
### Installation
128+
129+
Create and activate a Python 3.8 virtualenv then run:
128130

129131
```sh
130-
make
132+
make install
131133
```
132134

133-
Test package locally with:
135+
to install the package including development and testing dependencies
136+
137+
### Running tests
138+
139+
Run the test suite with:
140+
141+
```sh
142+
make test
143+
```
134144

135-
make test
145+
### Running static analysis
136146

137-
and:
147+
Use these make commands
138148

139149
```sh
140150
make lint
151+
make black
152+
make isort
141153
```
142154

143-
Development docker images can be built with:
155+
Docker images for these jobs can be built with:
144156

145157
```sh
146158
make docker_images
147159
```
148160

149-
which creates separate images for pytest, isort and black. Each can be run like so:
161+
This creates separate images for pytest, isort and black. Each can be run like
162+
so:
150163

151164
```sh
152165
docker run -v `pwd`:/opt/app xocto/pytest
153166
docker run -v `pwd`:/opt/app xocto/isort
154167
docker run -v `pwd`:/opt/app xocto/black
155168
```
156169

157-
## Release new version
170+
### Publishing
158171

159172
Release to PyPI by:
160173

0 commit comments

Comments
 (0)