Skip to content

Commit a8eaa62

Browse files
Merge 76721f3 into 29e537b
2 parents 29e537b + 76721f3 commit a8eaa62

File tree

6 files changed

+20
-8
lines changed

6 files changed

+20
-8
lines changed

.flake8

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ exclude =
4242
thinking
4343
.idea
4444
# custom scripts, not being part of the distribution
45-
libs_external
4645
sdist_upip.py
4746
setup.py
4847

.github/workflows/test.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,6 @@ jobs:
6363
--package_changelog_file changelog.md \
6464
--package_file package.json \
6565
--validate
66+
# use --ignore-version to skip version validation
67+
# use --ignore-deps to skip dependency validation
68+
# use --ignore-boot-main to skip boot.py and main.py files in URLs

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ Connect the MicroPython device to a network (if possible)
7272
```python
7373
import network
7474
station = network.WLAN(network.STA_IF)
75+
station.active(True)
7576
station.connect('SSID', 'PASSWORD')
7677
station.isconnected()
7778
```
@@ -104,11 +105,12 @@ mip.install("github:brainelectronics/micropython-package-template", version="fea
104105
mip.install("github:brainelectronics/micropython-package-template", version="0.6.0")
105106
```
106107

107-
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`
108+
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`.
109+
With `upip` always the latest available version will be installed.
108110

109111
```python
110112
import upip
111-
upip.install('micropython-package-template==0.1.1')
113+
upip.install('micropython-package-template')
112114
```
113115

114116
#### Test version
@@ -123,13 +125,14 @@ import mip
123125
mip.install("github:brainelectronics/micropython-package-template", version="0.6.0-rc9.dev13")
124126
```
125127

126-
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`
128+
For MicroPython versions below 1.19.1 use the `upip` package instead of `mip`.
129+
With `upip` always the latest available version will be installed.
127130

128131
```python
129132
import upip
130133
# overwrite index_urls to only take artifacts from test.pypi.org
131134
upip.index_urls = ['https://test.pypi.org/pypi']
132-
upip.install('micropython-package-template==0.2.0rc1.dev6')
135+
upip.install('micropython-package-template')
133136
```
134137

135138
See also [brainelectronics Test PyPi Server in Docker][ref-brainelectronics-test-pypiserver]

changelog.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ r"^\#\# \[\d{1,}[.]\d{1,}[.]\d{1,}\] \- \d{4}\-\d{2}-\d{2}$"
1717
-->
1818

1919
## Released
20+
## [0.8.1] - 2023-06-12
21+
### Fixed
22+
- Usage documentation with more comments and WiFi instructions in root README
23+
- Installation of latest available package version with `upip` mentioned in root README
24+
- Available package validation options added as comment to test workflow
25+
2026
## [0.8.0] - 2023-03-29
2127
### Added
2228
- Add `MicoPython` as `Implementation` in setup `classifiers`, see [#16](https://github.com/brainelectronics/micropython-package-template/issues/16)
@@ -115,8 +121,9 @@ r"^\#\# \[\d{1,}[.]\d{1,}[.]\d{1,}\] \- \d{4}\-\d{2}-\d{2}$"
115121
- [`setup.py`](setup.py) and [`sdist_upip.py`](sdist_upip.py) file
116122

117123
<!-- Links -->
118-
[Unreleased]: https://github.com/brainelectronics/micropython-package-template/compare/0.8.0...main
124+
[Unreleased]: https://github.com/brainelectronics/micropython-package-template/compare/0.8.1...main
119125

126+
[0.8.1]: https://github.com/brainelectronics/micropython-package-template/tree/0.8.1
120127
[0.8.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.8.0
121128
[0.7.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.7.0
122129
[0.6.0]: https://github.com/brainelectronics/micropython-package-template/tree/0.6.0

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@
1414
]
1515
],
1616
"deps": [],
17-
"version": "0.8.0"
17+
"version": "0.8.1"
1818
}

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
'License :: OSI Approved :: MIT License',
2929
'Programming Language :: Python :: Implementation :: MicroPython',
3030
],
31-
keywords='micropython, template',
31+
keywords='micropython, template, package',
3232
project_urls={
3333
'Bug Reports': 'https://github.com/brainelectronics/micropython-package-template/issues',
3434
'Source': 'https://github.com/brainelectronics/micropython-package-template',

0 commit comments

Comments
 (0)