Merge pull request #49 from tngTUDOR/issue-46

Issue 46

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/brightway-lca/cookiecutter-brightwaylib",
-  "commit": "ed6d9090fe8aebb87cd198be5b1abe84e39db280",
+  "commit": "9ee47efb8072303cf6476d873f392c7753d98082",
   "checkout": null,
   "context": {
     "cookiecutter": {

.github/workflows/conda-package-deploy.yaml

@@ -4,6 +4,7 @@ name: Build and deploy conda packages (bw2ui and bw25ui)
 on:
   push:
     branches: [main, develop]
+    tags: '*'
     paths-ignore:
       # Don't re-build if we only change README.md Or CHANGES.md
       - '**.md'
@@ -22,7 +23,9 @@ jobs:
         with:
           python-version: 3.11
           auto-activate-base: true
-      - run: |
+      - name: Publish distribution 📦 to conda channels
+        if: startsWith(github.ref, 'refs/tags')
+        run: |
           conda info
           conda config --set auto_update_conda False
           conda install -y -q conda-build anaconda-client

.github/workflows/python-package-deploy-bw25.yml

@@ -6,6 +6,7 @@ name: Build and publish bw25ui Python 🐍 distributions 📦 to PyPI
 on:
   push:
     branches: [main, develop]
+    tags: '*'
     paths-ignore:
       # Don't re-build if we only change README.md Or CHANGES.md
       - '**.md'
@@ -48,5 +49,5 @@ jobs:
         #repository-url: https://test.pypi.org/legacy/
         #skip-existing: true
     - name: Publish distribution 📦 to PyPI
-      #if: startsWith(github.ref, 'refs/tags')
+      if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/python-package-deploy.yml

@@ -6,6 +6,7 @@ name: Build and publish bw2ui Python 🐍 distributions 📦 to PyPI
 on:
   push:
     branches: [main, develop]
+    tags: '*'
     paths-ignore:
       # Don't re-build if we only change README.md Or CHANGES.md
       - '**.md'
@@ -45,5 +46,5 @@ jobs:
         #repository-url: https://test.pypi.org/legacy/
         #skip-existing: true
     - name: Publish distribution 📦 to PyPI
-      #if: startsWith(github.ref, 'refs/tags')
+      if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -93,7 +93,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+_build/
 
 # PyBuilder
 target/

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ exclude: '^docs/conf.py'
 
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v4.6.0
   hooks:
   - id: trailing-whitespace
   - id: check-added-large-files
@@ -42,7 +42,7 @@ repos:
     args: [--settings-path=pyproject.toml]
 
 - repo: https://github.com/psf/black
-  rev: 24.3.0
+  rev: 24.4.2
   hooks:
   - id: black
     args: [--config=pyproject.toml]

CHANGELOG.md → CHANGES.md

@@ -1,5 +1,13 @@
 # ui Changelog
 
+## [0.39.0]
+
++ support new MultiLCA class API changes
+
+## [0.38.0]
+
++ better handling of text flow for ii text fields
+
 ## [0.37.0]
 
 + add option to search by CAS number (only biosphere dbs)

CONTRIBUTING.md

@@ -78,8 +78,6 @@ $ pytest
 Unit tests are located in the _tests_ directory,
 and are written using the [pytest][pytest] testing framework.
 
-[pytest]: https://pytest.readthedocs.io/
-
 ## How to submit changes
 
 Open a [pull request] to submit changes to this project.
@@ -109,8 +107,3 @@ This will allow a chance to talk it over with the owners and validate your appro
 
 [pytest]: https://pytest.readthedocs.io/
 [pull request]: https://github.com/brightway-lca/brightway2-ui/pulls
-
-
-<!-- github-only -->
-
-[Code of Conduct]: CODE_OF_CONDUCT.md

README.md

@@ -1,5 +1,22 @@
 # Brightway2-UI
 
+[![PyPI](https://img.shields.io/pypi/v/bw25ui.svg)][pypi status]
+[![Status](https://img.shields.io/pypi/status/bw25ui.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/bw25ui)][pypi status]
+[![License](https://img.shields.io/pypi/l/bw25ui)][license]
+
+[![Read the documentation at https://brightway2-ui.readthedocs.io/](https://img.shields.io/readthedocs/brightway2-ui/latest.svg?label=Read%20the%20Docs)][read the docs]
+[![Codecov](https://codecov.io/gh/brightway-lca/brightway2-ui/branch/main/graph/badge.svg)][codecov]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+
+[pypi status]: https://pypi.org/project/bw25ui/
+[read the docs]: https://brightway2-ui.readthedocs.io/
+[codecov]: https://app.codecov.io/gh/brightway-lca/brightway2-ui
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
 This is now the official repo for  Brightway2-UI:
 
 > a web and command line user interface, part of the **Brightway2 LCA framework** <https://brightway.dev>.
@@ -63,3 +80,54 @@ The current main branch will be kept as the branch for development, with identic
 ### Mid term
 
 Once Brightway3 starts to exist, the main branch will be dedicated to it, with a `bw3ui` package.
+
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide][Contributor Guide].
+
+## License
+
+Distributed under the terms of the [BSD-3 license][License],
+_bw2ui_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue][Issue Tracker] along with a detailed description.
+
+
+<!-- github-only -->
+
+[command-line reference]: https://brightway2-ui.readthedocs.io/en/latest/usage.html
+[License]: https://github.com/brightway-lca/brightway2-ui/blob/main/LICENSE
+[Contributor Guide]: https://github.com/brightway-lca/brightway2-ui/blob/main/CONTRIBUTING.md
+[Issue Tracker]: https://github.com/brightway-lca/brightway2-ui/issues
+
+
+## Building the Documentation
+
+You can build the documentation locally by installing the documentation Conda environment:
+
+```bash
+conda env create -f docs/environment.yml
+```
+
+activating the environment
+
+```bash
+conda activate sphinx_brightway2-ui
+```
+
+and [running the build command](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#sphinx-build):
+
+```bash
+sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html
+```
+
+and [running the build command](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#sphinx-build):
+
+```bash
+sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html
+```

bw2ui/__init__.py

@@ -5,4 +5,4 @@
     # Add functions and variables you want exposed in `bw2ui.` namespace here
 )
 
-__version__ = "0.37.0"
+__version__ = "0.39.0"