Skip to content

Commit

Permalink
Release/1.3.1 (#803)
Browse files Browse the repository at this point in the history
* Update contributing.md file. Refs #756 (#757)

* Update contributing
* Update changelog

* #766 add extra id field to language dropdown

* rename param

* move property to options

* Remove dependency in docs on mkvirtualenv. Refs #773 (#775)

* Update README

* Add link to contibution guidelines.

* Update README.

* Update CHANGES.

* Remove pytz from delete_scheme script (#782)

* Remove pytz from delete_scheme script. Refs #780

* Update changelog. Refs #780

* trigger reload list on save

* Update pyramid_skosprovider. Refs #794 (#797)

* Update changelog.

* Drop pytz usages. (#796)

Issue #781

* Update CHANGES

* Update Changelog.

* Update versions.

* Prepare for release 1.3.1

* Fix syntax error in README

---------

Co-authored-by: Jonas Geuens <jonasgeuens@gmail.com>
Co-authored-by: Vanderhaegen Cedrik <cedrik.vanderhaegen@vlaanderen.be>
Co-authored-by: Wim De Clercq <declewi@gmail.com>
  • Loading branch information
4 people authored Mar 14, 2023
1 parent 0ffab90 commit 294e396
Show file tree
Hide file tree
Showing 18 changed files with 131 additions and 51 deletions.
13 changes: 13 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
1.3.1 (14-03-2023)
------------------

- Show acutal language tags in admin interface drop downs, as opposed to just the labels to reduce confusion. (#766)
- JSON-LD export was broken because the provided context was missing a context
attribute. (#794)
- Added a link from a concept page in the admin interface to the public interface. (#791)
- Saving a concept in the admin interface triggers a reload of the list view. (#763)
- Fix notation of JSON-LD. (#792)
- Update docs to no longer reference mkvirtualenv, use standard venv instead (#773)
- Update CONTRIBUTING.md file (#756)
- Remove unneeded references to pytz (#780, #796)

1.3.0 (04-01-2023)
-------------------

Expand Down
34 changes: 20 additions & 14 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,31 @@ authors:
email: koen.vandaele@vlaanderen.be
affiliation: Agentschap Onroerend Erfgoed
orcid: 'https://orcid.org/0000-0002-8153-2978'
- given-names: Bart
family-names: Saelen
affiliation: Geo Solutions
- given-names: Maarten
family-names: Taeymans
affiliation: Geo Solutions
- given-names: Jonathan
family-names: Piraux
- given-names: Tinne
family-names: Cahy
- given-names: Cedrik
family-names: Vanderhaegen
affiliation: GEO Solutions
- given-names: Wim
family-names: De Clercq
affiliation: GEO Solutions
- given-names: Jonas
family-names: Geuens
affiliation: Agentschap Onroerend Erfgoed
orcid: 'https://orcid.org/0000-0001-8197-5034'
- given-names: Wim
family-names: De Clercq
- given-names: Bram
family-names: Goessens
affiliation: Agentschap Onroerend Erfgoed
- given-names: Jonathan
family-names: Piraux
affiliation: GEO Solutions
- given-names: Bart
family-names: Saelen
affiliation: GEO Solutions
- given-names: Maarten
family-names: Taeymans
affiliation: GEO Solutions
- given-names: Cedrik
family-names: Vanderhaegen
affiliation: Agentschap Onroerend Erfgoed
repository-code: 'https://github.com/OnroerendErfgoed/atramhasis'
abstract: >-
Atramhasis is an online SKOS editor. This
Expand Down Expand Up @@ -62,6 +67,7 @@ references:
family-names: Meganck
email: leen.meganck@vlaanderen.be
affiliation: Agentschap Onroerend Erfgoed
orcid: 'https://orcid.org/0000-0002-9483-0851'
journal: ISPRS Annals of Photogrammetry, Remote Sensing and Spatial Information Sciences
volume: 4W2
pages: 151-156
Expand All @@ -81,5 +87,5 @@ keywords:
- vocabulary
- python
license: GPL-3.0
version: 1.3.0
date-released: '2023-01-04'
version: 1.3.1
date-released: '2023-03-14'
37 changes: 29 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,28 @@
Contributing
============

Atramhasis is being developed as open source software by the
[Flanders Heritage Agency]. All development is done on the agency's
[Github page for Atramhasis].
Atramhasis is an open source SKOS editor developed by [Flanders Heritage].
Consult the [Atramhasis documentation] for more information. All development
is done through our [Github page for Atramhasis]. If you run into bugs or
would like to request a new feature, please open a [Github issue]. Please
provide some context to your question such as the operating system,
Python and Atramhasis versions you are running. If you have specific questions
about the software or the datasets hosted at [Flanders Heritage Thesaurus]
you would rather not address in a public forum, please mail us at
<ict@onroerenderfgoed.be>.

Since we place a lot of importance of code quality, we expect to have a good
If you have some
exerience with Python, Javascript, RDF or SKOS, feel free to contribute
where you can. If you are unsure if a particular change would be welcome,
create a [Github issue] first. When doing so, we recommend you follow these
guidelines.

Please setup a local installation according to the [development guidelines] in
our online documentation, especially if you are looking to make a major
contribution. For certain changes, such as updating a part of the documentation
this is not necessary.

We place a lot of importance on code quality, expect to have a good
amount of code coverage present and run frequent unit tests. All commits and
pull requests will be tested with [Travis-ci]. Code coverage is being
monitored with [Coveralls].
Expand Down Expand Up @@ -33,17 +50,21 @@ bugfix/<ticketnumber>_description_of_fix
feature/<ticketnumber>_description_of_feature
````
Branches should be branched from develop and merged back into develop once approved
through a pull request.
Feature and bugfix branches should be branched from develop and will be merged
back into develop once approved through a pull request.
Every pull request will be run through [Travis-ci]. When providing a pull
request, please run the unit tests first and make sure they all pass. Please
provide new unit tests to maintain 100% coverage. If you send us a pull request
and this build doesn't function, please correct the issue at hand or let us
that doesn't pass all tests, please correct the issue at hand or let us
know why it's not working.
[Flanders Heritage Agency]: https://www.onroerenderfgoed.be
[Flanders Heritage]: https://www.onroerenderfgoed.be
[Atramhasis documentation]: https://atramhasis.readthedocs.io/en/latest
[Flanders Heritage Thesaurus]: https://thesaurus.onroerenderfgoed.be
[Github page for Atramhasis]: https://github.com/OnroerendErfgoed/atramhasis
[Github issue]: https://github.com/OnroerendErfgoed/atramhasis/issues
[development guidelines]: https://atramhasis.readthedocs.io/en/latest/development.html
[Travis-ci]: https://travis-ci.org/OnroerendErfgoed/atramhasis
[Coveralls]: https://coveralls.io/r/OnroerendErfgoed/atramhasis
[pytest]: http://pytest.org
Expand Down
29 changes: 27 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,30 @@ Atramhasis is an online SKOS editor. This webapplication enables
users to create SKOS vocabularies consisting of Concepts and Collections. It
tries to stay close to the SKOS specification. This makes it suited for different
types of vocabularies such as simple pick lists, authority files, flat lists and
basic to relatively complex thesauri. Atramhasis is not suited for managing very
large or complex thesauri such as the `AAT <http://vocab.getty.edu>`_.
basic to relatively complex thesauri. For a full overview of capabilities, please
consult our `documentation <https://atramhasis.readthedocs.io/en/latest/features.html>`_.
If you want a quick demo of what the system provides for a typical end user,
have a look at the `Flanders Heritage Thesaurus <https://thesaurus.onroerenderfgoed.be>`_.
This is an implementation of Atramhasis for the `Flanders Heritage Agency <https://www.onroerenderfgoed.be>`_
containing several vocabularies regarding cultural heritage, such as
`heritagetypes <https://thesaurus.onroerenderfgoed.be/conceptschemes/ERFGOEDTYPES>`_,
`styles and cultures <https://thesaurus.onroerenderfgoed.be/conceptschemes/STIJLEN_EN_CULTUREN>`_,
`materials <https://thesaurus.onroerenderfgoed.be/conceptschemes/MATERIALEN>`_
and `periods <https://thesaurus.onroerenderfgoed.be/conceptschemes/DATERINGEN>`_.
Most of the vocabularies are in Dutch, but the interface is available in both
Dutch, English and French.

All development is done through `Github <https://github.com/OnroerendErfgoed/atramhasis>`_.
If you run into bugs or would like to request a new feature, please open a
`Github issue <https://github.com/OnroerendErfgoed/atramhasis/issues>`_. Please
provide some context to your question such as the operating system,
Python and Atramhasis versions you are running. If you have specific questions
about the software or the datasets hosted at
`Flanders Heritage Thesaurus <https://thesaurus.onroerenderfgoed.be>`_
you would rather not address in a public forum, please mail us at
ict@onroerenderfgoed.be.

Contributions are welcome. This could be improvements to the code, updated
documentation or adding a new translation to the User Interface. Please see our
`contribution guidelines <https://github.com/OnroerendErfgoed/atramhasis/blob/develop/CONTRIBUTING.md>`_
to find out how we can collaborate.
2 changes: 1 addition & 1 deletion atramhasis/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.3

info:
title: Atramhasis API
version: 1.3.0
version: 1.3.1

servers:
- url: '/'
Expand Down
2 changes: 0 additions & 2 deletions atramhasis/scripts/delete_scheme.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
from builtins import input
from pyramid.paster import get_appsettings
from pyramid.paster import setup_logging
from pytz import timezone
from sqlalchemy import engine_from_config

timezone_brussels = timezone('Europe/Brussels')
log = logging.getLogger(__name__)


Expand Down
4 changes: 1 addition & 3 deletions atramhasis/scripts/sitemap_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@
from builtins import input
from pyramid.paster import get_appsettings, bootstrap
from pyramid.paster import setup_logging
from pytz import timezone
from sqlalchemy import engine_from_config
from sqlalchemy.orm import sessionmaker

from atramhasis.errors import SkosRegistryNotFoundException

timezone_brussels = timezone('Europe/Brussels')
log = logging.getLogger(__name__)


Expand Down Expand Up @@ -110,12 +108,12 @@ def create_index_sitemap(base_url, directory):
sitemapindex = ElementTree.Element(
"sitemapindex", xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
)
today = datetime.date.today().isoformat()

for file_name in list_sitemaps:
sitemap_static_url = f"{base_url}/sitemaps/{file_name}"
sitemap_area = ElementTree.SubElement(sitemapindex, "sitemap")
ElementTree.SubElement(sitemap_area, "loc").text = sitemap_static_url
today = datetime.datetime.now(timezone_brussels).strftime("%Y-%m-%d")
ElementTree.SubElement(sitemap_area, "lastmod").text = today

write_element_to_xml("sitemap_index.xml", directory, sitemapindex)
Expand Down
2 changes: 1 addition & 1 deletion atramhasis/static/admin/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "atramhasis",
"version": "1.3.0",
"version": "1.3.1",
"description": "Node packages for building Atramhasis.",
"repository": {
"type": "git",
Expand Down
2 changes: 2 additions & 0 deletions atramhasis/static/admin/src/app/ui/AppUi.js
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ define([
var tab = this._getTab(schemeId + '_' + concept.id);
this._closeTab(tab);
this._openConcept(res.id, schemeId);
this._searchPane.reload();
topic.publish('dGrowl', 'The concept was successfully saved.', {
'title': 'Save successful',
'sticky': false,
Expand All @@ -623,6 +624,7 @@ define([
// save successful
view._close();
this._openConcept(res.id, schemeId);
this._searchPane.reload();
topic.publish('dGrowl', 'The concept was successfully saved.', {
'title': 'Save successful',
'sticky': false,
Expand Down
3 changes: 2 additions & 1 deletion atramhasis/static/admin/src/app/ui/dialogs/LabelsDialog.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ define([
DomUtils.addOptionsToSelect(this.langSelectNode, {
data: this.langList,
idProperty: 'id',
labelProperty: 'name'
labelProperty: 'name',
showId: true
});
},

Expand Down
5 changes: 5 additions & 0 deletions atramhasis/static/admin/src/app/ui/widgets/SearchPane.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ define([
this._grid.set('collection', store);
},

reload: function () {
console.debug('SearchPane::reload');
this._grid.set('collection', this.appUi.conceptController.getConceptStore(this._scheme));
},

_createGrid: function (node) {
console.debug('SearchPane::_createGrid');

Expand Down
8 changes: 4 additions & 4 deletions atramhasis/static/admin/src/app/utils/DomUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ define([
* labelProperty: {string}
* }
*/
addOptionsToSelect: function (select, options){
array.forEach(options.data, function (item) {
domConstruct.place('<option value="' + item[options.idProperty] + '">' + item[options.labelProperty] + '</option>',
select);
addOptionsToSelect: function (select, options) {
options.data.forEach(item => {
const itemProp = options.showId ? item[options.labelProperty] + ' (' + item[options.idProperty] + ')' : item[options.labelProperty];
domConstruct.place(`<option value="${item[options.idProperty]}">${itemProp}</option>`, select);
});
},

Expand Down
2 changes: 1 addition & 1 deletion atramhasis/static/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "atramhasis",
"version": "1.3.0",
"version": "1.3.1",
"description": "Node packages for public part of Atramhasis.",
"repository": {
"type": "git",
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
# The short X.Y version.
version = '1.3'
# The full version, including alpha/beta/rc tags.
release = '1.3.0'
release = '1.3.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
26 changes: 16 additions & 10 deletions docs/source/demo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,13 @@ Heritage Thesaurus <https://thesaurus.onroerenderfgoed.be>`_ or by running a
demo yourself. This allows you to quickly evaluate and inspect the software.
This can be done through the `cookiecutter` package.

.. code-block:: bash
$ mkvirtualenv atramhasis_demo
$ pip install -U cookiecutter
.. code-block:: bash
$ python -m venv atramhasis_demo
$ . atramhasis_demo/bin/activate
# Make sure pip and setuptools are up to date
$ pip install --upgrade pip setuptools
$ pip install -U cookiecutter
Once cookiecutter is installed, you use it to generate the demo site.

Expand Down Expand Up @@ -145,12 +148,15 @@ Atramhasis scaffold

Create an Atramhasis scaffold (if you want to deploy an existing scaffold, skip this step)

.. code-block:: bash
$ mkvirtualenv atramhasis_heroku
$ pip install -U atramhasis
$ pcreate -s atramhasis_demo atramhasis_heroku
$ cd atramhasis_heroku
.. code-block:: bash
$ python -m venv atramhasis_heroku
$ . atramhasis_heroku/bin/activate
# Make sure pip and setuptools are up to date
$ pip install --upgrade pip setuptools
$ pip install -U atramhasis
$ pcreate -s atramhasis_demo atramhasis_heroku
$ cd atramhasis_heroku
Git repository
--------------
Expand Down
7 changes: 6 additions & 1 deletion docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,10 @@ We recommend installing Atramhasis in a virtual environment.

.. code-block:: bash
$ mkvirtualenv atramhasis_dev
$ python -m venv atramhasis_dev
$ . atramhasis_dev/bin/activate
# Make sure pip and setuptools are up to date
$ pip install --upgrade pip setuptools
To install a fully working development environment a pip requirements-dev.txt
file is provided. By passing this file to :command:`pip install -r` all
Expand All @@ -86,6 +89,8 @@ to the admin module documentation.
# Install dependencies
$ pip install -r requirements-dev.txt
# Install packages in dev mode
$ pip install -e .
# create or update database
$ alembic upgrade head
# insert sample data
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ openapi-spec-validator==0.4.0 # https://github.com/p1c2u/openapi-core/issues/44
# skosprovider
skosprovider==1.2.0
skosprovider_sqlalchemy==1.0.0
pyramid_skosprovider==1.1.0
pyramid_skosprovider==1.2.0
skosprovider_rdf==1.3.0
skosprovider_getty==1.1.0

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def run(self):
]

setup(name='atramhasis',
version='1.3.0',
version='1.3.1',
description='A web based editor for thesauri adhering to the SKOS specification.',
long_description=README + '\n\n' + CHANGES,
long_description_content_type='text/x-rst',
Expand Down

0 comments on commit 294e396

Please sign in to comment.