Commit 5cd14bf4 authored by Szilárd Pfeiffer's avatar Szilárd Pfeiffer
Browse files

docs: Use uv instead of pipenv and pip 

The pipeline and the project environment moved to uv, so the instructions
given to contributors and users named a tool the project no longer uses.
parent d7d58bba

CONTRIBUTING.rst

+1 −1
Original line number Diff line number Diff line
@@ -143,7 +143,7 @@ Preparing your Fork 
3. ``cd theproject``

4. `Create and activate a virtual

   environment <https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments>`__.

5. Install the development requirements: ``pip install .[tests]``.

5. Install the development requirements: ``uv sync --extra tests``.

6. Create a branch: ``git checkout -b foo-the-bars 1.3``.



Making your Changes

README.md

+2 −2
Original line number Diff line number Diff line
@@ -65,10 +65,10 @@ GnuTLS, LibreSSL, or wolfSSL. As a result, CryptoLyzer recognizes more TLS ciphe 


## Usage



### pip

### uv



```shell

pip install cryptolyzer

uv tool install cryptolyzer

```



```shell

docs/development.rst

+3 −5
Original line number Diff line number Diff line
@@ -2,14 +2,12 @@ 
Development

-----------



If you want to setup a development environment, you are in need of `pipenv <https://docs.pipenv.org/>`__.

If you want to setup a development environment, you are in need of `uv <https://docs.astral.sh/uv/>`__.



.. code:: shell



   git clone --recurse-submodules \

   https://gitlab.com/coroner/cryptolyzer

   cd cryptolyzer

   pipenv install --dev

   pipenv run python setup.py develop

   pipenv shell

   cryptolyze -h
 
   uv sync --extra tests

   uv run --env-file .env cryptolyze -h

docs/installation.rst

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ Python Package 


.. code:: shell



   pip install cryptolyzer

   uv tool install cryptolyzer



Docker

======

llms.txt

+1 −1
Original line number Diff line number Diff line
@@ -171,7 +171,7 @@ 
## Install



``` bash

pip install cryptolyzer

uv tool install cryptolyzer



# or via Docker

docker run --rm coroner/cryptolyzer tls all example.com