Skip to content

Commit

Permalink
Update licenses and add a note to the readme about them (#71)
Browse files Browse the repository at this point in the history
* Add/switch licenses

* Slight add to readme

* markdown formatting

* Swap to LICENSING.md scheme

* Add SPDX-License-Identifier

* Readme tweak
  • Loading branch information
SandersAaronD authored Aug 1, 2024
1 parent 7dbfc0d commit c8e4e84
Show file tree
Hide file tree
Showing 15 changed files with 694 additions and 3 deletions.
661 changes: 661 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions LICENSING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Licensing

License names used in this document are as per [SPDX License List](https://spdx.org/licenses/).

The default license for this project is [AGPL-3.0-only](LICENSE).

## Apache-2.0

The following directories and their subdirectories are licensed under [Apache-2.0](o11y/LICENSE):

```
o11y/
```
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ Layout is as follows:
- `grafana-aitraining-app/` contains the grafana plugin

## Development

Requires:

- Python (3.8 or later)
- Hatch (best installed via "pipx install hatch" if you have pipx)
- Node (20 or later)
Expand All @@ -24,3 +26,7 @@ Builds dev environment with "make docker"
Once it's up, you can background it or open another terminal and use "make jupyter" to open a jupyter server. It will have a link to jupyter in your terminal.

Grafana will be hosted at localhost:3000 with the plugin.

## Licensing

See [LICENSING.md](LICENSING.md)
File renamed without changes.
1 change: 1 addition & 0 deletions o11y/src/o11y-go/hello.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// SPDX-License-Identifier: Apache-2.0
package main

import "fmt"
Expand Down
1 change: 1 addition & 0 deletions o11y/src/o11y/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# SPDX-License-Identifier: Apache-2.0
# __init__.py
import logging

Expand Down
1 change: 1 addition & 0 deletions o11y/src/o11y/_internal/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# SPDX-License-Identifier: Apache-2.0
from .o11y_go import *
1 change: 1 addition & 0 deletions o11y/src/o11y/_internal/client.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# SPDX-License-Identifier: Apache-2.0
# Contains a python object representing the metadata client
# This should handle anything related to the job itself, like registering the job, updating metadata, etc
# This should not be used for logging, metrics, etc
Expand Down
2 changes: 2 additions & 0 deletions o11y/src/o11y/_internal/o11y_go.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# SPDX-License-Identifier: Apache-2.0

import pkg_resources
import subprocess

Expand Down
2 changes: 1 addition & 1 deletion o11y/src/o11y/_internal/util/validate_url.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# SPDX-License-Identifier: Apache-2.0
import re

url_regex = re.compile(
Expand All @@ -20,4 +21,3 @@ def validate_url(url):
"""

return bool(url_regex.match(url))

1 change: 1 addition & 0 deletions o11y/src/o11y/exported/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# SPDX-License-Identifier: Apache-2.0
3 changes: 2 additions & 1 deletion o11y/src/o11y/exported/finish.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# SPDX-License-Identifier: Apache-2.0
from .. import client

def finish():
"""
Finishes the current process
:return: None
"""
client.report_state("successful")
client.report_state("successful")
1 change: 1 addition & 0 deletions o11y/src/o11y/exported/init.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# SPDX-License-Identifier: Apache-2.0
from .. import client
from .. import logger

Expand Down
1 change: 1 addition & 0 deletions o11y/src/o11y/exported/log.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from typing import Dict, Union, Optional
# SPDX-License-Identifier: Apache-2.0
from .. import client
from .. import logger

Expand Down
3 changes: 2 additions & 1 deletion o11y/src/o11y/exported/update.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# SPDX-License-Identifier: Apache-2.0
from .. import client

def update(metadata):
Expand All @@ -7,4 +8,4 @@ def update(metadata):
"""
# TODO: Validate the metadata
client.update_metadata(metadata)
return True
return True

0 comments on commit c8e4e84

Please sign in to comment.