Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 59 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# versipy v0.2.4.post1
# versipy v0.2.5

![](pictures/versipy.png)

Expand Down Expand Up @@ -65,9 +65,9 @@ conda update -c aleg -c anaconda -c bioconda -c conda-forge versipy

The following dependencies are required but automatically installed with pip or conda package manager

- colorlog>=4.1.0
- pyyaml>=5.3.1
- gitpython>=3.1.9
- colorlog>=4.1.0
- pyyaml>=5.3.1
- gitpython>=3.1.9

## Usage

Expand Down Expand Up @@ -179,14 +179,65 @@ deploy:
tags: true
```

### Lists

In addition to simple string replacement, `versipy` offers some advanced syntax for the support of lists (such as
dependencies or classifiers). This syntax allows to some flexibility in formatting lists depending on the template.

If a managed variable in `versipy.yaml` contains a list, the template needs to specify the formatting as such:

`__@{<SEPARATOR>::<PREFIX><VARIABLE_NAME><SUFFIX>}`__

For example, if `versipy.yaml` contains this entry:

```yaml
managed_values:
__dependencies__:
- numpy
- pandas
- matplotlib
```

And the template for `setup.py` contains the following line:
```python
install_requires=["colorlog>=4.1.0", "pyyaml>=5.3.1", "gitpython>=3.1.9"],
```

then versipy will interpret `, ` as the list separator, and `"` as both prefix and suffix. The resulting line will then be:

```python
install_requires=["numpy", "pandas", "matplotlib"],
```

Wheras in `meta.yaml` you might define in the template:
```yaml
run:
- colorlog>=4.1.0
- pyyaml>=5.3.1
- gitpython>=3.1.9
```

where `versipy` interprets `\n - ` as the separator, and the prefix and suffix are empty strings. The resulting `meta.yaml`
will then contain:

```yaml
run:
- numpy
- pandas
- matplotlib
```


---



## Classifiers

* Development Status :: 3 - Alpha
* Intended Audience :: Science/Research
* Topic :: Scientific/Engineering :: Bio-Informatics
* License :: OSI Approved :: GNU General Public License v3 (GPLv3)
* Development Status :: 3 - Alpha
* Intended Audience :: Science/Research
* Topic :: Scientific/Engineering :: Bio-Informatics
* License :: OSI Approved :: GNU General Public License v3 (GPLv3)
* Programming Language :: Python :: 3

## citation
Expand Down
2 changes: 1 addition & 1 deletion meta.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% set version = "0.2.4.post1" %}
{% set version = "0.2.5" %}
{% set name = "versipy" %}

package:
Expand Down
12 changes: 9 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,22 @@
setup(
name="versipy",
description="Versatile version and medatada managment across the python packaging ecosystem with git integration",
version="0.2.4.post1",
version="0.2.5",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/a-slide/versipy",
author="Adrien Leger",
author_email="contact@adrienleger.com",
license="GPLv3",
python_requires=">=3.6",
classifiers=["Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "Topic :: Scientific/Engineering :: Bio-Informatics", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python :: 3"],
install_requires=["colorlog>=4.1.0", "pyyaml>=5.3.1", "gitpython>=3.1.9"],
classifiers=["Development Status :: 3 - Alpha",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering :: Bio-Informatics",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Programming Language :: Python :: 3"],
install_requires=["colorlog>=4.1.0",
"pyyaml>=5.3.1",
"gitpython>=3.1.9"],
packages=["versipy"],
package_dir={"versipy": "versipy"},
package_data={"versipy": ["templates/*"]},
Expand Down
22 changes: 12 additions & 10 deletions versipy.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
version:
major: 0
minor: 2
micro: 4
micro: 5
a: null
b: null
rc: null
post: 1
post: null
dev: null
managed_values:
__package_name__: versipy
Expand All @@ -19,14 +19,16 @@ managed_values:
__package_licence_url__: https://www.gnu.org/licenses/gpl-3.0.en.html
__minimal_python__: '>=3.6'
__entry_point1__: versipy=versipy.__main__:main
__dependency1__: colorlog>=4.1.0
__dependency2__: pyyaml>=5.3.1
__dependency3__: gitpython>=3.1.9
__classifiers_1__: 'Development Status :: 3 - Alpha'
__classifiers_2__: 'Intended Audience :: Science/Research'
__classifiers_3__: 'Topic :: Scientific/Engineering :: Bio-Informatics'
__classifiers_4__: 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)'
__classifiers_5__: 'Programming Language :: Python :: 3'
__dependencies__:
- colorlog>=4.1.0
- pyyaml>=5.3.1
- gitpython>=3.1.9
__classifiers__:
- 'Development Status :: 3 - Alpha'
- 'Intended Audience :: Science/Research'
- 'Topic :: Scientific/Engineering :: Bio-Informatics'
- 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)'
- 'Programming Language :: Python :: 3'
__citation__: Adrien Leger. (2020, October 27). a-slide/versipy 0.2.2 (Version 0.2.2).
Zenodo. http://doi.org/10.5281/zenodo.4139248
managed_files:
Expand Down
2 changes: 1 addition & 1 deletion versipy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
__name__ = "versipy"
__version__ = "0.2.4.post1"
__version__ = "0.2.5"
__description__ = "Versatile version and medatada managment across the python packaging ecosystem with git integration"
__url__ = "https://github.com/a-slide/versipy"
__licence__ = "GPLv3"
Expand Down
Loading