Metadata-Version: 2.1
Name: hosting-benchmark
Version: 0.0.6
Summary: PHP Web-hosting benchmark
Home-page: https://github.com/samupl/hosting-benchmark
Author: Jakub Szafrański
Author-email: kontakt@samu.pl
License: UNKNOWN
Description: # hosting-benchmark
        
        A full web-hosting benchmark suite
        
        ## Installation
        
        Install using pip:
        
        ```shell script
        pip install hosting-benchmark
        ```
        
        ## Usage
        
        The benchmark consists of two components:
        
        * A *server*, which is a set of PHP scripts that run the benchmark
        * A *client*, which is a cli (command line interface) tool used to run the
          benchmark and collect/present the data.
        
        In order to run the benchmark, you need to install the server app. This is
        fairly straightforward:
        
        * Create a MySQL database on your web hosting, note down the credentials
        * Run `hosting-benchmark archive` to prepare a ZIP archive with the server.
          You will be asked to provide your database credentials
        * Upload and extract the zip package to your web hosting http root directory
        * Run the benchmark using:
        
        ```shell script
        hosting-benchmark --hostname=https://example.com/ --count=10 --sleep=5 all
        ```
        
        To learn what the `--count` and `--sleep` flags do, please invoke
        `hosting-benchmark --help`.
        
        ## Development
        
        ### Precommit Hooks
        
        This project supports [pre-commit](https://pre-commit.com/). To use it please install it in the `pip install pre-commit` and then run `pre-commit install` and you are ready to go. `black` will be executed before commit and files will be formatted correctly.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
