Skip to content

Commit

Permalink
docs: update README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
vst committed Sep 25, 2024
1 parent d9cedec commit 3a7415c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 22 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Copyright (2017-2019) Vehbi Sinan Tunalioglu.
Copyright (2019-2023) Teloscube Pte Ltd.
Copyright (2019-2024) Teloscube Pte Ltd.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
Expand Down
31 changes: 10 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DECAF API Client (Python)

[![Github](https://github.com/telostat/decaf-api-client-python/workflows/Install%20and%20Test/badge.svg)](https://github.com/telostat/decaf-api-client-python/actions)
[![Test](https://github.com/teloscube/decaf-client-python/actions/workflows/test.yml/badge.svg)](https://github.com/teloscube/decaf-client-python/actions/workflows/test.yml)

> **TODO:** Provide a complete README file.
Expand All @@ -9,35 +9,21 @@
A Nix shell is provided for development:

```sh
nix-shell
nix develop
```

Run tests:
Build to run tests:

```sh
tox
```

Open the codebase in Visual Studio Code:

```sh
code .
```

Alternatively, you can issue following commands directly without entering the
Nix shell:

```sh
nix-shell --arg python "\"python39\"" --run tox
nix-shell --arg python "\"python310\"" --run tox
nix build
```

## Build and Publish

Build the source distribution:

```sh
python setup.py sdist bdist_wheel
python -m build --sdist --wheel
```

Check the distribution(s):
Expand All @@ -54,5 +40,8 @@ twine upload -s dist/*

## License and Copyrights

This software is licensed under [The 3-Clause BSD
License](https://opensource.org/licenses/BSD-3-Clause).
This software is licensed under [The 3-Clause BSD License].

<!-- REFERENCES -->

[The 3-Clause BSD License]: https://opensource.org/licenses/BSD-3-Clause

0 comments on commit 3a7415c

Please sign in to comment.