Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
V
VIPSCore-Python-Common
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
VIPS
VIPSCore-Python-Common
Commits
8f71f78c
Commit
8f71f78c
authored
2 years ago
by
Tor-Einar Skog
Browse files
Options
Downloads
Patches
Plain Diff
More docs updates
parent
de2378b4
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+23
-2
23 additions, 2 deletions
README.md
with
23 additions
and
2 deletions
README.md
+
23
−
2
View file @
8f71f78c
...
...
@@ -12,8 +12,17 @@ pip3 install git+https://gitlab.nibio.no/VIPS/vipscore-python-common.git@v0.1.6
```
...where the version is specified after the
`@`
If you're implementing a VIPS model, typical imports would be
## Unit tests
```
python
from
vipscore_common.vips_model
import
VIPSModel
from
vipscore_common.entities
import
Result
,
ModelConfiguration
,
WeatherObservation
from
vipscore_common.data_utils
import
*
```
## Developer guide
### Unit tests
The tests are located in the
`tests`
folder, and we're using
[
Pytest
](
https://docs.pytest.org/
)
To run the unit tests, move to the root folder of the project, and execute:
...
...
@@ -22,5 +31,17 @@ To run the unit tests, move to the root folder of the project, and execute:
pytest
-v
```
## References
### Using bumpver
For developers: When you want to publish a new version, use
```
bash
# Increment the PATCH version when you make backwards compatible bug fixes.
bumpver update
--patch
# Increment the MINOR version when you add functionality in a backwards compatible manner.
bumpver update
--minor
# Increment the MAJOR version when you make incompatible API changes.
bumpver update
--major
```
[
(Source)
](
https://semver.org/#summary
)
### References
We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment