File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -122,39 +122,52 @@ from xocto import localtime
122122
123123See [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
140150make 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
146158make 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
152165docker run - v `pwd` :/ opt/ app xocto/ pytest
153166docker run - v `pwd` :/ opt/ app xocto/ isort
154167docker run - v `pwd` :/ opt/ app xocto/ black
155168```
156169
157- # # Release new version
170+ # ## Publishing
158171
159172Release to PyPI by:
160173
You can’t perform that action at this time.
0 commit comments