Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brightway-lca/bw_projects
https://github.com/brightway-lca/bw_projects
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/brightway-lca/bw_projects
- Owner: brightway-lca
- License: bsd-2-clause
- Created: 2022-09-21T03:09:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T08:25:36.000Z (about 1 year ago)
- Last Synced: 2024-11-12T13:43:16.604Z (about 2 months ago)
- Language: Python
- Size: 113 KB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# bw_projects
[][pypi status]
[][pypi status]
[][pypi status]
[][license]
[][tests]
[][codecov]
[][pre-commit]
[][black]
[pypi status]: https://pypi.org/project/bw_projects/
[tests]: https://github.com/brightway-lca/bw_projects/actions?workflow=Tests
[codecov]: https://codecov.io/gh/brightway-lca/bw_projects
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
This is a library to manage subdirectories, so that work on a project can be isolated from other projects. It is designed for use with the [Brightway life cycle assessment](https://brightway.dev/) software framework, but has no dependencies on Brightway and can be used on its own.
Project metadata is stored in SQLite using the [Peewee ORM](http://docs.peewee-orm.com/en/latest/). The SQLite file is in the `base_directory`, and project data is stored in subdirectories. By default, [platformdirs](https://github.com/platformdirs/platformdirs) is used to create the `base_directory`, though this can be overridden.
## Installation
Via pip or conda (`conda-forge` channel).
Depends on:
* [peewee](http://docs.peewee-orm.com/en/latest/)
* [platformdirs](https://github.com/platformdirs/platformdirs)
* [python_slugify](https://github.com/un33k/python-slugify)
## Usage
### Initializing the ProjectsManager
```python
from bw_projects import ProjectsManager # This doesn't create anything yet
projects_manager = ProjectsManager() # This gets default config and initializes directories and database
```
### Overriding defaults
```python
## You can override default directory by providing a base directory in constructor
## You can also override the default database name
from bw_projects import ProjectsManager
projects_manager = ProjectsManager(dir_base_data="", database_name="projects.db")
```
```python
## You can also override configurations of default directory
from bw_projects import Configuration, ProjectsManager
config = Configuration(
app_name: str = "Brightway3",
app_author: str = "pycla",
)
projects_manager = ProjectsManager(config=config)
```
### Callbacks
```python
## You can setup callbacks on projects creation, activation and deletion
from bw_projects import ProjectsManager
def callback_activate_project(manager: ProjectsManager, name: str, attributes: Dict[str, str], dir_path: str):
print(f"Manager with {len(manager)} projects activated project {name} with {attributes} and {dir_path}.")
projects_manager = ProjectsManager(callbacks_activate_project=callback_activate_project)
```
### Project management
| :exclamation: Project names may be changed when creating projects |
|---------------------------------------------------------------------|
```python
## Before calling any project-management feature, the project name is slugified
## You can get the new name of the project by running:
project = projects_manager.get_clean_directory_name("Компьютер")
project
>> kompiuter
```
```python
## Create a project without activating it:
projects_manager.create_project("")
```
```python
## Create a project and activate it:
projects_manager.create_project("", activate=True)
```
```python
## Iterate over projects:
for project in projects_manager:
print(project.name, project.attributes)
```
```python
## Activate a project:
projects_manager.activate("")
```
```python
## Delete a project from SQLite database and deleting the directory:
projects_manager.delete_project("")
```
```python
## Delete a project from SQLite database without deleting the directory:
projects_manager.delete_project("", delete_dir=False)
```
## Contributing
Contributions are very welcome.
To learn more, see the [Contributor Guide][Contributor Guide].
## License
Distributed under the terms of the [BSD-2-Clause license][License],
_bw_projects_ is free and open source software.
## Issues
If you encounter any problems,
please [file an issue][Issue Tracker] along with a detailed description.
[License]: https://github.com/brightway-lca/bw_projects/blob/main/LICENSE
[Contributor Guide]: https://github.com/brightway-lca/bw_projects/blob/main/CONTRIBUTING.md
[Issue Tracker]: https://github.com/brightway-lca/bw_projects/issues