Skip to content

Commit b3c1215

Browse files
GautzillaGautzilla
authored
License readme (#327)
* add doi badge * add MIT license in pyproject.toml * add citation.cff * add LICENSE file * add citation link in Contributing doc * add CONTRIBUTING.md * add ref to APLOSE in readme
1 parent 78ebba6 commit b3c1215

6 files changed

Lines changed: 126 additions & 1 deletion

File tree

‎CITATION.cff‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
authors:
2+
- affiliation: ENSTA
3+
family-names: Berthomieu
4+
given-names: Gauthier
5+
orcid: 0000-0001-9527-4087
6+
- affiliation: ENSTA
7+
family-names: Cazau
8+
given-names: Dorian
9+
orcid: 0000-0003-4414-1721
10+
- family-names: Loire
11+
given-names: Benjamin
12+
orcid: 0009-0005-0362-1835
13+
- affiliation: ENSTA
14+
family-names: Mathieu Dupont
15+
- family-names: Anatole Gros-Martial
16+
- affiliation: ENSTA
17+
family-names: Torterotot
18+
given-names: Maelle
19+
orcid: 0000-0002-8912-2463
20+
- affiliation: ENSTA
21+
family-names: Morin
22+
given-names: Elodie
23+
orcid: 0009-0000-3919-1463
24+
- family-names: Carvaillo
25+
given-names: Paul
26+
- family-names: Dubus
27+
given-names: Gabriel
28+
orcid: 0009-0000-9390-6765
29+
cff-version: 1.2.0
30+
date-released: '2026-01-22'
31+
doi: 10.5281/zenodo.18337275
32+
identifiers:
33+
- type: swh
34+
value: swh:1:dir:a543d6089126ffcb64e9ab87e2046c1940acd8ea;origin=https://doi.org/10.5281/zenodo.18337274;visit=swh:1:snp:2ef4d0a3cee6b9a69d76f21dd32dd99c0d3e43cf;anchor=swh:1:rel:25b5f0a5812251a7bb313752af46a4ea9d625386;path=Project-OSmOSE-OSEkit-78ebba6
35+
license:
36+
- mit
37+
message: If you use this software, please cite it using the metadata from this file.
38+
repository-code: https://github.com/Project-OSmOSE/OSEkit/tree/v0.4.3
39+
title: OSEkit
40+
type: software
41+
version: v0.4.3

‎CONTRIBUTING.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contribute to OSEkit
2+
3+
Thank you for your interest in this project.
4+
5+
This document describes the rules and best practices to
6+
follow when contributing to the development of the software.
7+
8+
9+
## Contributions
10+
11+
There are many ways to contribute to this project, including:
12+
13+
- **Starring** the [OSEkit GitHub page](https://github.com/Project-OSmOSE/OSEkit) to show the world that you use it
14+
- **Referencing OSEkit** in your articles
15+
16+
(see *"Cite this repository"* in [the About section of the OSEkit GitHub page](https://github.com/Project-OSmOSE/OSEkit))
17+
18+
- **Participating** in the [OSEkit GitHub](https://github.com/Project-OSmOSE/OSEkit) by:
19+
- **Reporting** difficulties you encounter when using the package in new [issues](https://github.com/Project-OSmOSE/OSEkit/issues)
20+
- **Suggesting** functionalities that would come in handy in **OSEkit** in new [issues](https://github.com/Project-OSmOSE/OSEkit/issues)
21+
- **Reviewing** existing [pull requests](https://github.com/Project-OSmOSE/OSEkit/pulls)
22+
- **Authoring** new [pull requests](https://github.com/Project-OSmOSE/OSEkit/pulls) to:
23+
- **Add** new cool functionalities
24+
- **Fix** things that don't work exactly the way they should
25+
- **Improve** the documentation
26+
27+
Any contribution submitted to this project is deemed to be provided
28+
under the project's MIT license, without additional restrictions.
29+
30+
By submitting a contribution, you warrant that:
31+
- You are the author of the contribution or have the necessary rights,
32+
- The contribution does not violate any third-party rights,
33+
- The contribution is provided under the project's MIT license.
34+
- No contributions can be accepted under a different or incompatible license.
35+
36+
## Contribution process
37+
38+
Please refer to the [Contributing page in our official documentation](https://project-osmose.github.io/OSEkit/contributing.html#github-contributor-workflow)
39+
for a straightforward guide on how to push your contribution to our repo!

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025-present [ENSTA, Lab-STICC UMR CNRS 6285]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
[![Coverage Status](https://coveralls.io/repos/github/Project-OSmOSE/OSEkit/badge.svg?branch=version-bump)](https://coveralls.io/github/Project-OSmOSE/OSEkit?branch=version-bump)
1313
![license](https://img.shields.io/github/license/mashape/apistatus.svg)
1414
![Open Source Love](https://img.shields.io/badge/open%20source-♡-lightgrey)
15+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18337275.svg)](https://doi.org/10.5281/zenodo.18337275)
1516
![Python 3.12](https://img.shields.io/pypi/pyversions/osekit)
1617

1718

@@ -35,6 +36,7 @@ It is primarily designed for working on underwater passive acoustics data, but c
3536
- Seamless, timestamp-based access across multiple files (e.g., pick a 3-minutes long segment spannign over two 1.5-minutes long files without manual file picking)
3637
- Preprocessing utilities: resampling, normalization...
3738
- Spectral analysis routines: compute power spectra, spectrograms, LTAS...
39+
- A high-level **API** designed to work with [APLOSE](https://github.com/Project-OSmOSE/APLOSE), our web-base spectrogram annotation tool
3840

3941
**OSEkit** treats your audio dataset as a continuous timeline, whatever the raw files configuration.
4042
You request audio by time intervals and the package fetches from the raw files behind the scenes: no manual I/O juggling required.
@@ -45,8 +47,27 @@ You request audio by time intervals and the package fetches from the raw files b
4547

4648
All details to start using our toolkit and make the most out of it are given in our [documentation](https://project-osmose.github.io/OSEkit/).
4749

48-
<br>
4950

51+
This software is distributed under the MIT license.
52+
53+
You are free to use, modify, and redistribute it, provided that you retain the copyright
54+
notices and license text, in accordance with the terms of this license.
55+
56+
See the [LICENSE](./LICENSE) file for the full text.
57+
58+
Some third-party libraries are used in this project. Details of their licenses are
59+
available in the repository [dependency graph](https://github.com/Project-OSmOSE/OSEkit/network/dependencies).
60+
61+
This software must not be sold.
62+
63+
If you use this software in scientific work, please cite it in accordance with the
64+
[CITATION](./CITATION.cff) file.
65+
66+
This software is provided for research and teaching purposes. It is provided “as is,”
67+
without warranty. The authors and the institution cannot be held responsible for any
68+
damage resulting from its use.
69+
70+
<br>
5071

5172
<div align="center">
5273

‎docs/source/contributing.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ There are many ways to contribute to this project, including:
99

1010
- **Starring** the `OSEkit GitHub page <https://github.com/Project-OSmOSE/OSEkit>`_ to show the world that you use it
1111
- **Referencing OSEkit** in your articles
12+
(see *"Cite this repository"* in `the About section of the OSEkit GitHub page <https://github.com/Project-OSmOSE/OSEkit>`_)
13+
1214
- **Participating** in the `OSEkit GitHub <https://github.com/Project-OSmOSE/OSEkit>`_ by:
1315
- **Reporting** difficulties you encounter when using the package in new `issues <https://github.com/Project-OSmOSE/OSEkit/issues>`_
1416
- **Suggesting** functionalities that would come in handy in **OSEkit** in new `issues <https://github.com/Project-OSmOSE/OSEkit/issues>`_

‎pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ name = "osekit"
33
version = "0.4.3"
44
description = "OSEkit"
55
readme = "README.md"
6+
license = "MIT"
67
authors = [
78
{ name = "OSmOSE team", email = "osmose@ensta-bretagne.fr" }
89
]

0 commit comments

Comments
 (0)