Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mohit Beniwal authored and Mohit Beniwal committed Jul 1, 2024
1 parent c0c4cd2 commit 56ba86c
Show file tree
Hide file tree
Showing 8 changed files with 185 additions and 83 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/cli-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: CLI Tests

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Add src directory to Python path
run: |
export PYTHONPATH=$PYTHONPATH:$(pwd)/src
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Run CLI tests
run: |
pytest --cov=local_vault.cli --cov-report=xml --cov-report=term tests/test_cli.py
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: coverage.xml
flags: cli
name: cli-tests
# fail_ci_if_error: true
39 changes: 39 additions & 0 deletions .github/workflows/crypto-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Crypto Tests

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Run Crypto tests
run: |
pytest tests/test_crypto.py --junitxml=results.xml
- name: Upload test results
uses: actions/upload-artifact@v3
with:
name: crypto-test-results
path: results.xml
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4.0.1
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: results.xml
flags: crypto
name: crypto-tests
40 changes: 0 additions & 40 deletions .github/workflows/main.yml

This file was deleted.

39 changes: 39 additions & 0 deletions .github/workflows/storage-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Storage Tests

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Run Storage tests
run: |
pytest tests/test_storage.py --junitxml=results.xml
- name: Upload test results
uses: actions/upload-artifact@v3
with:
name: storage-test-results
path: results.xml
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4.0.1
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: results.xml
flags: storage
name: storage-tests
40 changes: 0 additions & 40 deletions .github/workflows/test_and_update_results.yml'

This file was deleted.

39 changes: 39 additions & 0 deletions .github/workflows/utils-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Utils Tests

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
test:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Run Utils tests
run: |
pytest tests/test_utils.py --junitxml=results.xml
- name: Upload test results
uses: actions/upload-artifact@v3
with:
name: utils-test-results
path: results.xml
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4.0.1
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: results.xml
flags: utils
name: utils-tests
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
# Local Ark
## Build Status

Local Ark is a secure, command-line based password and sensitive information manager designed for developers and security-conscious users. It provides a robust, encrypted storage solution for your sensitive data, right on your local machine.
[![codecov](https://codecov.io/github/dev-mohitbeniwal/ark/graph/badge.svg?token=W8TAIVKKHH)](https://codecov.io/github/dev-mohitbeniwal/ark)

### CLI Tests

![CLI Tests](https://github.com/dev-mohitbeniwal/ark/actions/workflows/cli-tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/dev-mohitbeniwal/ark/branch/main/graph/badge.svg?flag=cli)](https://codecov.io/gh/dev-mohitbeniwal/ark)

### Storage Tests

![Storage Tests](https://github.com/dev-mohitbeniwal/ark/actions/workflows/storage-tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/dev-mohitbeniwal/ark/branch/main/graph/badge.svg?flag=storage)](https://codecov.io/gh/dev-mohitbeniwal/ark)

### Crypto Tests

![Crypto Tests](https://github.com/dev-mohitbeniwal/ark/actions/workflows/crypto-tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/dev-mohitbeniwal/ark/branch/main/graph/badge.svg?flag=crypto)](https://codecov.io/gh/dev-mohitbeniwal/ark)

### Utils Tests

![Utils Tests](https://github.com/dev-mohitbeniwal/ark/actions/workflows/utils-tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/dev-mohitbeniwal/ark/branch/main/graph/badge.svg?flag=utils)](https://codecov.io/gh/dev-mohitbeniwal/ark)

# Ark

Ark is a secure, command-line based password and sensitive information manager designed for developers and security-conscious users. It provides a robust, encrypted storage solution for your sensitive data, right on your local machine.

## Features

Expand Down Expand Up @@ -124,4 +148,4 @@ This project is licensed under the MIT License - see the LICENSE file for detail

### Disclaimer

While Local Ark implements various security measures, no system is 100% secure. Use at your own risk and always follow best practices for password management and system security.
While Ark implements various security measures, no system is 100% secure. Use at your own risk and always follow best practices for password management and system security.
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ pyperclip==1.9.0
pytest==8.2.2
setuptools==69.5.1
wheel==0.43.0
pytest
pytest-cov
codecov

0 comments on commit 56ba86c

Please sign in to comment.