Skip to content

Commit

Permalink
Change company Name (#86)
Browse files Browse the repository at this point in the history
AB#8752
  • Loading branch information
eccles authored Nov 10, 2023
1 parent 542adf9 commit 9309353
Show file tree
Hide file tree
Showing 38 changed files with 165 additions and 158 deletions.
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
RKVST observes the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md), reproduced below for emphasis.
DataTrails observes the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md), reproduced below for emphasis.

### Contributor Code of Conduct

Expand Down Expand Up @@ -32,7 +32,7 @@ Conduct may be permanently removed from the project team.
This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting an RKVST administrator on <support@rkvst.com>.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting an DataTrails administrator on <support@datatrails.ai>.

This Code of Conduct is adapted from the Contributor Covenant
(http://contributor-covenant.org), version 1.2.0, available at
Expand Down
10 changes: 5 additions & 5 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rkvst-samples - developers
# datatrails-samples - developers

Sample python code that uses the rkvst python SDK to manage particular types of assets
Sample python code that uses the datatrails python SDK to manage particular types of assets
such as 'doors', 'cards', 'containers' etc.

This document describes how to test any modifications made to the codebase.
Expand All @@ -12,7 +12,7 @@ Required tools for modifying this repo are task-runner and docker-ce.
- Install task runner: https://github.com/go-task/task
- Install docker-ce: https://docs.docker.com/get-docker/

A running rkvst instance which allows creation of arbitrary assets etc. This is usually
A running datatrails instance which allows creation of arbitrary assets etc. This is usually
a test or demo system and **not** a production system.

# Running the samples code
Expand All @@ -32,10 +32,10 @@ task api
## Authorization

Add a token to the file credentials/.auth_token and set some environment vars to
specify the rkvst endpoint:
specify the datatrails endpoint:

```bash
export TEST_ARCHIVIST="https://app.rkvst.io"
export TEST_ARCHIVIST="https://app.datatrails.ai"
export TEST_AUTHTOKEN_FILENAME=credentials/.auth_token
export TEST_NAMESPACE="unique label"
export TEST_VERBOSE=-v
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019-2022 RKVST
Copyright (c) 2019-2022 DataTrails

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rkvst-samples
# datatrails-samples

Sample python code that uses the rkvst python SDK to manage particular types of assets
Sample python code that uses the datatrails python SDK to manage particular types of assets
such as 'doors', 'cards', 'containers' etc.

# Installing the samples code
Expand All @@ -10,7 +10,7 @@ Python 3.8 and later versions are supported.
Use the standard python pip utility:

```bash
python3 -m pip install --user rkvst-samples
python3 -m pip install --user datatrails-samples
```

and this will create 7 entry points:
Expand All @@ -30,7 +30,7 @@ Add a token to the file credentials/.auth_token and set some environment vars to
specify the archivist endpoint:

```bash
export TEST_ARCHIVIST="https://app.rkvst.io"
export TEST_ARCHIVIST="https://app.datatrails.ai"
export TEST_AUTHTOKEN_FILENAME=credentials/.auth_token
export TEST_NAMESPACE="unique label"
export TEST_VERBOSE=-v
Expand All @@ -44,7 +44,7 @@ TEST_PROOF_MECHANISM should be "KHIPU" or "SIMPLE_HASH". If unspecified the defa
Windows using Powershell - at the command prompt set values for environment variables:

```bash
$Env:TEST_ARCHIVIST="https://app.rkvst.io"
$Env:TEST_ARCHIVIST="https://app.datatrails.ai"
$Env:TEST_AUTHTOKEN_FILENAME = '<path of token location>'
$Env:TEST_NAMESPACE = Get-Date -UFormat %s
$Env:TEST_VERBOSE = '-v'
Expand Down
10 changes: 5 additions & 5 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,27 @@ tasks:
api:
desc: Build a docker environment with the right dependencies and utilities
cmds:
- docker build --no-cache --build-arg VERSION=3.8 -f Dockerfile -t rkvst-samples-api .
- docker build --no-cache --build-arg VERSION=3.8 -f Dockerfile -t datatrails-samples-api .

api-3.9:
desc: Build a docker environment with the right dependencies and utilities
cmds:
- docker build --no-cache --build-arg VERSION=3.9 -f Dockerfile -t rkvst-samples-api .
- docker build --no-cache --build-arg VERSION=3.9 -f Dockerfile -t datatrails-samples-api .

api-3.10:
desc: Build a docker environment with the right dependencies and utilities
cmds:
- docker build --no-cache --build-arg VERSION=3.10 -f Dockerfile -t rkvst-samples-api .
- docker build --no-cache --build-arg VERSION=3.10 -f Dockerfile -t datatrails-samples-api .

api-3.11:
desc: Build a docker environment with the right dependencies and utilities
cmds:
- docker build --no-cache --build-arg VERSION=3.11 -f Dockerfile -t rkvst-samples-api .
- docker build --no-cache --build-arg VERSION=3.11 -f Dockerfile -t datatrails-samples-api .

api-3.12:
desc: Build a docker environment with the right dependencies and utilities
cmds:
- docker build --no-cache --build-arg VERSION=3.12 -f Dockerfile -t rkvst-samples-api .
- docker build --no-cache --build-arg VERSION=3.12 -f Dockerfile -t datatrails-samples-api .

check:
desc: Check the style, bug and quality of the code
Expand Down
6 changes: 3 additions & 3 deletions archivist_samples/c2pa/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# C2PA Sample

The purpose of this sample is to demonstrate how one can record and trace the lifecycle of an embedded file manifest within RKVST thus providing a historical chain of events of wanted or unwanted changes and/or updates.
The purpose of this sample is to demonstrate how one can record and trace the lifecycle of an embedded file manifest within DataTrails thus providing a historical chain of events of wanted or unwanted changes and/or updates.

Note: For clarity and simplicity this sample does not show how to create the C2PA manifest itself, but rather uses pre-prepared files generated by the standard c2patool.

## Pre-requisites

* Python 3.8 and later versions are supported.

* Install the [RKVST samples Python package](https://pypi.org/project/rkvst-samples/ "PyPi package page")
* Install the [DataTrails samples Python package](https://pypi.org/project/datatrails-samples/ "PyPi package page")

* Get an authorization bearer token and store it in the file `credentials/.auth_token`. If you don't know how to do this, please refer to the [RKVST documentation](https://docs.rkvst.com/docs/rkvst-basics/getting-access-tokens-using-app-registrations/ "Getting an auth token"). Make sure that the `credentials` folder is suitably restricted by disallowing root and group access.
* Get an authorization bearer token and store it in the file `credentials/.auth_token`. If you don't know how to do this, please refer to the [DataTrails documentation](https://docs.datatrails.ai/docs/datatrails-basics/getting-access-tokens-using-app-registrations/ "Getting an auth token"). Make sure that the `credentials` folder is suitably restricted by disallowing root and group access.


## Running the sample
Expand Down
2 changes: 1 addition & 1 deletion archivist_samples/c2pa/c2pa.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def upload_attachment(arch, attachment_description: AttachmentDescription):
blob = arch.attachments.upload(fd)
attachment = {
# sample-specific attr to relay attachment name
"rkvst_samples_display_name": attachment_description.attribute_name,
"datatrails_samples_display_name": attachment_description.attribute_name,
"arc_file_name": attachment_description.filename,
"arc_attribute_type": "arc_attachment",
"arc_blob_identity": blob["identity"],
Expand Down
2 changes: 1 addition & 1 deletion archivist_samples/c2pa/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def run(arch, args):
"""
runs the sample and returns the system error code.
"""
LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
LOGGER.info("Using version %s of datatrails-archivist", about.__version__)
LOGGER.info("Fetching use case test assets namespace %s", args.namespace)

# remove the trailing / on the url if it exists
Expand Down
6 changes: 3 additions & 3 deletions archivist_samples/document/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Document Lineage Sample

RKVST offers complete document lineage.
DataTrails offers complete document lineage.

This sample focuses on an invoice document for a fabricated Asteroid Mining Company.

Expand All @@ -19,9 +19,9 @@ If the document contains sensitive information, it is also possible to just prov

* Python 3.8 and later versions are supported.

* Install the [RKVST samples Python package](https://pypi.org/project/rkvst-samples/ "PyPi package page")
* Install the [DataTrails samples Python package](https://pypi.org/project/datatrails-samples/ "PyPi package page")

* Get an authorization bearer token and store it in the file `credentials/.auth_token`. If you don't know how to do this, please refer to the [RKVST documentation](https://docs.rkvst.com/docs/rkvst-basics/getting-access-tokens-using-app-registrations/ "Getting an auth token"). Make sure that the `credentials` folder is suitably restricted by disallowing root and group access.
* Get an authorization bearer token and store it in the file `credentials/.auth_token`. If you don't know how to do this, please refer to the [DataTrails documentation](https://docs.datatrails.ai/docs/datatrails-basics/getting-access-tokens-using-app-registrations/ "Getting an auth token"). Make sure that the `credentials` folder is suitably restricted by disallowing root and group access.


## Running the sample
Expand Down
2 changes: 1 addition & 1 deletion archivist_samples/document/document.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def upload_attachment(arch, attachment_description: AttachmentDescription):
blob = arch.attachments.upload(fd)
attachment = {
# sample-specific attr to relay attachment name
"rkvst_samples_display_name": attachment_description.attribute_name,
"datatrails_samples_display_name": attachment_description.attribute_name,
"arc_file_name": attachment_description.filename,
"arc_attribute_type": "arc_attachment",
"arc_blob_identity": blob["identity"],
Expand Down
2 changes: 1 addition & 1 deletion archivist_samples/document/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def run(arch, args):
"""
runs the sample and returns the system error code.
"""
LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
LOGGER.info("Using version %s of datatrails-archivist", about.__version__)
LOGGER.info("Fetching use case test assets namespace %s", args.namespace)

# remove the trailing / on the url if it exists
Expand Down
12 changes: 6 additions & 6 deletions archivist_samples/door_entry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

Access control is not just an issue for files and computer systems: when it comes to connected door locks it's a real world issue. Various stakeholders (landlords, building services, police, delivery companies) have legitimate reasons to enter the communal areas of shared buildings but the residents and owners of that building also need to be sure of their safety and privacy. How do you makes sure that privileged access to buildings is enabled whilst also holding the authorities to account and preventing abuses?

RKVST Data Assurance Hub offers a solution to this problem: by ensuring that all stakeholders have a transparent view of privileged access events, abuses are discouraged and quickly discovered. By combining virtual world evidence (cryptographic identities, timestamps) with real world evidence (photographs from the built-in camera from the door access system) a very strong record of when who accessed a building is maintained and made available for audit and dispute resolution.
DataTrails Data Assurance Hub offers a solution to this problem: by ensuring that all stakeholders have a transparent view of privileged access events, abuses are discouraged and quickly discovered. By combining virtual world evidence (cryptographic identities, timestamps) with real world evidence (photographs from the built-in camera from the door access system) a very strong record of when who accessed a building is maintained and made available for audit and dispute resolution.

This sample simulates a set of smart connected door locks processing and reporting their privileged accesses through RKVST. Through simulating door access cards it also demonstrates RKVST's principle of building up asset provenance based on trusted Witness Statements rather than direct connection to assets, which provides much greater system visibility than traditional agent-based platforms.
This sample simulates a set of smart connected door locks processing and reporting their privileged accesses through DataTrails. Through simulating door access cards it also demonstrates DataTrails's principle of building up asset provenance based on trusted Witness Statements rather than direct connection to assets, which provides much greater system visibility than traditional agent-based platforms.


## Pre-requisites

* Python 3.8 and later versions are supported.

* Install the RKVST samples package. If you are just trying out the pre-made samples you should get the official [RKVST samples Python package](https://pypi.org/project/rkvst-samples/ "PyPi package page") from PyPi. If you are modifying this sample and want to try out your changes then you'll need to rebuild the wheel: please refer to the developer instructions in the top level of this repository to see how to do that.
* Install the DataTrails samples package. If you are just trying out the pre-made samples you should get the official [DataTrails samples Python package](https://pypi.org/project/datatrails-samples/ "PyPi package page") from PyPi. If you are modifying this sample and want to try out your changes then you'll need to rebuild the wheel: please refer to the developer instructions in the top level of this repository to see how to do that.

* Get an authorization bearer token and store it in the file `credentials/.auth_token`. If you don't know how to do this, please refer to the [RKVST documentation](https://docs.rkvst.com/docs/rkvst-basics/getting-access-tokens-using-app-registrations/ "Getting an auth token"). Make sure that the `credentials` folder is suitably restricted by disallowing root and group access.
* Get an authorization bearer token and store it in the file `credentials/.auth_token`. If you don't know how to do this, please refer to the [DataTrails documentation](https://docs.datatrails.ai/docs/datatrails-basics/getting-access-tokens-using-app-registrations/ "Getting an auth token"). Make sure that the `credentials` folder is suitably restricted by disallowing root and group access.


## Running the sample

The Taskfile in the top level of this repository includes a pre-packaged run of this sample that creates a number of door access terminals and access cards and simulates privileged access events which can then be viewed and analysed in your RKVST tenancy.
The Taskfile in the top level of this repository includes a pre-packaged run of this sample that creates a number of door access terminals and access cards and simulates privileged access events which can then be viewed and analysed in your DataTrails tenancy.

Please refer to the instructions in the [top level README](https://github.com/rkvst/rkvst-samples#door-entry-control "door entry sample")
Please refer to the instructions in the [top level README](https://github.com/datatrails/datatrails-samples#door-entry-control "door entry sample")

14 changes: 7 additions & 7 deletions archivist_samples/door_entry/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,24 +50,24 @@ def attachment_create(doors, attachment_description: AttachmentDescription):
####################################


def create_rkvst_paris(doors):
def create_datatrails_paris(doors):
# Unlike the others, which feature images of the whole building,
# this one is actually a close-up of the connected door terminal
return doors_creator(
doors,
"RKVST front door",
"DataTrails front door",
{
"arc_firmware_version": "1.0",
"arc_serial_number": "das-j1-01",
"arc_description": (
"Electronic door entry system controlling the main "
"staff entrance to RKVST France"
"staff entrance to DataTrails France"
),
"wavestone_asset_id": "paris.france.rkvst.das",
"wavestone_asset_id": "paris.france.datatrails.das",
},
location={
"props": {
"display_name": "RKVST Paris",
"display_name": "DataTrails Paris",
"description": "Sales and sales support for the French region",
"latitude": 48.8339211,
"longitude": 2.371345,
Expand Down Expand Up @@ -247,7 +247,7 @@ def create_gdn_side(doors):
def create_doors(doors):
LOGGER.info("Creating all doors...")
doors_map = {
"rkvst_paris": create_rkvst_paris(doors),
"datatrails_paris": create_datatrails_paris(doors),
"cityhall": create_cityhall(doors),
"courts": create_courts(doors),
"bastille": create_bastille(doors),
Expand Down Expand Up @@ -575,7 +575,7 @@ def run(arch, args):
"""
runs the sample and returns the system error code.
"""
LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
LOGGER.info("Using version %s of datatrails-archivist", about.__version__)
LOGGER.info("Fetching use case test assets namespace %s", args.namespace)

doors = copy(arch)
Expand Down
Loading

0 comments on commit 9309353

Please sign in to comment.