diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e00e17e --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# Project specific + diff --git a/.spinetoolbox/.gitignore b/.spinetoolbox/.gitignore new file mode 100644 index 0000000..298c95b --- /dev/null +++ b/.spinetoolbox/.gitignore @@ -0,0 +1,12 @@ +# Temporary and log files +*.log +*.bak? +*.sqlite-journal + +# Item output files +items/*/output + +# Other files created by execution +.export-manifest.json +filter_config.json + diff --git a/.spinetoolbox/project.json b/.spinetoolbox/project.json new file mode 100644 index 0000000..38b9181 --- /dev/null +++ b/.spinetoolbox/project.json @@ -0,0 +1,11 @@ +{ + "project": { + "version": 6, + "name": "toolbox-project-template", + "description": "This is a template for Spine Toolbox projects", + "specifications": {}, + "connections": [], + "jumps": [] + }, + "items": {} +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9034921 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Project template for Spine Toolbox + +This is a template repository for Git-versioned Spine Toolbox projects. +To create a new GitHub repository based on this template, click on the **Use this template** button. + +## Ignored files + +Some files are ignored by default: +- output files created by project execution +- temporary and log files + +Other project-specific ignores can be added to the [.gitignore](.gitignore) file. + + +## Folder strucure + +### `data` + +This folder could be used for storing the original data files. +Please add metadata and licensing information as well. + + +### `scripts` + +This folder could be used for storing processing scripts and their tool specifications. + + +## License and Terms of Use + +The Spine Toolbox project example provided here can be used without any +limitations. This does not necessarily apply to any data files contained within. diff --git a/UNLICENSE b/UNLICENSE new file mode 100644 index 0000000..ffba087 --- /dev/null +++ b/UNLICENSE @@ -0,0 +1,25 @@ +The Spine Toolbox project and the source code files are released into +the public domain. Any data files included are not covered by this dedication. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to diff --git a/data/INFO.md b/data/INFO.md new file mode 100644 index 0000000..6cc8b9b --- /dev/null +++ b/data/INFO.md @@ -0,0 +1,3 @@ +This folder can be used for storing original data files for the project. + +If possible, add *datapackage.json* file to make it a [Data Package](https://frictionlessdata.io/data-package/). \ No newline at end of file diff --git a/scripts/INFO.md b/scripts/INFO.md new file mode 100644 index 0000000..293c33e --- /dev/null +++ b/scripts/INFO.md @@ -0,0 +1 @@ +This folder can be used to store processing scripts and tool specifications used in the project. \ No newline at end of file