Added license, README and docs

jannisspeer · jannisspeer · commit a476918652ff · 2024-03-25T16:16:32.000+01:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jannis Speer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.
diff --git a/README.md b/README.md
@@ -0,0 +1,4 @@
+# Snakemake executor plugin: DIRAC
+
+A Snakemake executor plugin for submitting jobs with DIRAC interware.
+The documentation can be found in the [Snakemake plugin catalog](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/dirac.html).
diff --git a/docs/further.md b/docs/further.md
diff --git a/docs/intro.md b/docs/intro.md
@@ -0,0 +1 @@
+[DIRAC](https://dirac.readthedocs.io/en/latest/index.html) is an interware, meaning a software framework for distributed computing.
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,14 +5,18 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 name = "snakemake-executor-plugin-dirac"
 version = "0.1.0"
-description = ""
-authors = [ "jannisspeer <jannis.speer@tutanota.com>",]
+description = "A Snakemake executor plugin for submitting jobs with the DIRAC interware."
+authors = [
+    "Jannis Speer <jspeer@tutanota.com>",
+    "Fabio De Vellis <fa.devellis@gmail.com>",
+]
 readme = "README.md"
-repository = "https://github.com/your/plugin"
+license = "MIT"
+repository = "https://github.com/jannisspeer/snakemake-executor-plugin-dirac"
 documentation = "https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/dirac.html"
 
 [tool.poetry.dependencies]
-python = "^3.12"
+python = "^3.11"
 snakemake-interface-common = "^1.17.1"
 snakemake-interface-executor-plugins = "^9.0.0"
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[DIRAC](https://dirac.readthedocs.io/en/latest/index.html) is an interware, meaning a software framework for distributed computing.`