Giter Club home page Giter Club logo

kfs's Introduction

kfs

Run Python Tests pre-commit.ci status codecov

Usage

Initialize the database

kfs db init

Development

Local environment setup

  1. Ensure you have conda installed (once)
  2. Run make setup (initially, or when dependencies are changed)
  3. Run conda activate ./env (every time)
  4. Run pre-commit install (once)

Makefile targets

We use a Makefile for automating common development tasks. Each target in this list can be run with make <target>:

Target Description
clean Clean up cache and temporary files
clean-all Clean up, including build files and conda environment
help Display help on all Makefile targets
setup Setup local dev conda environment
test Run all the unit tests
tox Run tox to test in isolated environments

kfs's People

Contributors

mattkram avatar pre-commit-ci[bot] avatar renovate[bot] avatar

Stargazers

 avatar

Watchers

 avatar

kfs's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/ci.yml
  • actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
  • actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f
  • codecov/codecov-action v4@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673
pep621
pyproject.toml
  • rich <=13.7.1
  • sqlmodel <=0.0.11
  • typer <=0.12.3
  • dev/mypy <=1.10.1
  • dev/pytest <=8.2.2
  • dev/pytest-cov <=5.0.0
  • dev/toml <=0.10.2
  • setuptools-scm >=6.2
pre-commit
.pre-commit-config.yaml
  • pre-commit/pre-commit-hooks v4.6.0
  • macisamuele/language-formatters-pre-commit-hooks v2.14.0
  • pycqa/isort 5.13.2
  • psf/black 23.12.1
  • pycqa/flake8 7.1.0
  • anaconda/pre-commit-hooks v24.5.2

  • Check this box to trigger a request for Renovate to run again on this repository

Database Design

MVP database for kfs

For kfs, we need a database to store additional file metadata, like tags and stuff. The MVP of this will be the following:

  • User will configure a base directory to be tracked by kfs
  • Within this base directory will be all the files that will be tracked (recursively) and a sqlite3 database
  • The user will initialize this database with kfs db init

Database tables

To store tags for each file, we will need a many-to-many relationship, with three tables:

  1. files, one record per file, with the following columns:
    • A UUID to use as primary key
    • The filename
    • The path in which the file exists (kept separately for later anticipated functions to handle renaming and moves)
  2. tags, one per user-created tag. The user will likely use the syntax category:value, where value is optional. For now, we'll store a key and optional value column.
  3. An association table to store relationships between files and tags applied to them

Migrations

Not MVP, but eventually we will need kfs db migrate and kfs db upgrade, which wrap around alembic, much like flask-sqlalchemy.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (github>anaconda/renovate-config)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.