Skip to content

Commit

Permalink
chg: [documentation] Added information related to the storage and upd…
Browse files Browse the repository at this point in the history
…ated pyproject.toml.
  • Loading branch information
cedricbonhomme committed Aug 1, 2024
1 parent 8ea62ee commit 14f0310
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 7 deletions.
7 changes: 3 additions & 4 deletions docs/formats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,15 @@ hash table `h:` (history)

- `h:ipv4` / `h:ipv6`
- timestamp `epoch`
- value -> json raw result
- value -> JSON raw result

domain name/hostname set `s:`-> `h:`
````````````````````````````````````

If there is a domain name or hostname set -> ipv4 or ipv6.
If there is a domain name or hostname set -> IPv4 or IPv6.

- `s:domain` and `s:hostname`
- value ipv4 or ipv6

- value IPv4 or IPv6



Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In order to compile kvrocks, you will need a few packages:
git clone --recursive https://github.com/apache/incubator-kvrocks.git kvrocks
cd kvrocks
git checkout v2.5.1
git checkout v2.9.0
./x.py build
cd ..
Expand Down
24 changes: 22 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,25 @@ description = "Report Storage and Tracking of Observations and Records Efficient
authors = ["Cédric Bonhomme <[email protected]>"]
license = "AGPL-3.0-or-later"
readme = "README.md"
homepage = "https://github.com/scandale-project/RSTORE"
repository = "https://github.com/scandale-project/RSTORE"
documentation = "https://rstore.readthedocs.io"

keywords = ["observations", "evidences", "kvrocks", "api"]

classifiers = [
"Environment :: Console",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Topic :: Security",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Framework :: FastAPI",
"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)"
]

[tool.poetry.dependencies]
python = "^3.10"
Expand All @@ -13,11 +32,12 @@ fastapi = "^0.111.1"
valkey = "^6.0.0b1"
uvicorn = "^0.30.4"


[tool.poetry.group.dev.dependencies]
mypy = "^1.11.1"
flake8 = "^7.1.0"

[tool.poetry.group.docs]
optional = true

[tool.poetry.group.docs.dependencies]
sphinx = "^8.0.2"
Expand Down Expand Up @@ -50,4 +70,4 @@ exclude = "build|dist|docs"


[tool.isort]
profile = "black"
profile = "black"

0 comments on commit 14f0310

Please sign in to comment.