Merge pull request #29 from chkware/release/M.2022-03

Release for milestone `M.2022 03`

Author: 0hsn

README.md

@@ -2,7 +2,7 @@
 
 This repository holds source code and publishable website for [**`chkware`**](https://github.com/chkware/cli#readme). Please access using https://chkware.github.io.
 
-## Installation
+### Installation
 
 Clone the repo:
 
@@ -17,31 +17,33 @@ Install dependencies:
 npm install
 ```
 
-## Local Development
+### Local Development
 
 ```
 $ npm start
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and opens up a browser window. You can also follow `http://localhost:3000/` URL in any browser.
 
-## Build
+Most changes are reflected live reload without having to restart the server.
+
+### Build
 
 ```
 $ npm run build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-## Guides
+### Guides
 
 Learn how to contribute to this website.
 
 ### Configs
 
 All the configs can be found in `docusaurus.config.js`.
 
-### Create a doc page
+#### Create a doc page
 
 Create a Markdown file, `example.md`, and place it under the `docs` directory. Any markdown file will render into the site without needing any extra configuration. It will be displayed alphabetically on the sidebar.
 
@@ -55,7 +57,7 @@ root
 
 Markdown documents can use the Markdown front matter metadata fields, enclosed by a line `---` on either side. At the top of the file, you can optionally specify attributes in the front matter, so that Docusaurus will pick them up correctly when generating the site. Accepted fields can be found [here](https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter).
 
-### Create a doc category
+#### Create a doc category
 
 Creating a `example.md` in a sub folder will create a category in the sidebar.
 
@@ -74,41 +76,41 @@ To change the category name or other category meta data, an optional file `_cate
 }
 ```
 
-### Static Assets
+#### Static Assets
 
 The Static Assets can be found in the `static` folder. More [here](https://docusaurus.io/docs/next/static-assets).
 
-### Change theme color
+#### Change theme color
 
 Generate the variables from [here](https://docusaurus.io/docs/next/styling-layout#styling-your-site-with-infima). Then replace the variables in `src/css/custom.css` with these new variables. Don't forget variables for dark mode.
 
-### Change codeBlock theme
+#### Change codeBlock theme
 
 Docusaurus uses [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer) to highlight code blocks. All configuration are in the `prism` object of `docusaurus.config.js`. You can specify a custom theme from the [list of available themes](https://github.com/FormidableLabs/prism-react-renderer/tree/master/src/themes).
 
-### Syntax highlighting
+#### Syntax highlighting
 
 To add syntax highlighting for any of the other [Prism-supported languages](https://prismjs.com/#supported-languages), define it in an array of additional languages. More [here](https://docusaurus.io/docs/next/markdown-features/code-blocks#supported-languages).
 
-### Change footer
+#### Change footer
 
 You can add logo and a copyright to the footer via `themeConfig.footer`. More [here](https://docusaurus.io/docs/next/api/themes/configuration#footer-1).
 
-### Blog
+#### Blog
 
 To set up blog, start by creating a `blog` directory. More [here](https://docusaurus.io/docs/next/blog).
 
-### Admonitions
+#### Admonitions
 
 In addition to the basic Markdown syntax, Docusaurus use [remark-admonitions](https://github.com/elviswolcott/remark-admonitions) alongside MDX to add support for admonitions. Admonitions are wrapped by a set of 3 colons. More [here](https://docusaurus.io/docs/next/markdown-features/admonitions).
 
-### Update Docusaurus version
+#### Update Docusaurus version
 
 To update Docusaurus version, manually change the version number in `package.json` to the desired version. Then run `npm run install`.
 
 Any required change/depricated message will be shown on the terminal when running the command `npm run start`. More [here](https://docusaurus.io/docs/next/installation#updating-your-docusaurus-version).
 
-## Status
+### Status
 
 The current status of the website is **under construction**. Please follow us on Twitter [@chkware](https://twitter.com/chkware) for update. Thank you for your patience.
 

docs/00-home.md

@@ -0,0 +1,42 @@
+---
+slug: /
+title: Home
+hide_title: true
+---
+
+![chkware | Test management for api era](./assets/github-readme-01.png)
+
+[![PyPI version](https://badge.fury.io/py/chk.svg)](https://badge.fury.io/py/chk)
+[![Python 3.8](https://img.shields.io/badge/python-3.10-red.svg)](https://www.python.org/downloads/release/python-3102/)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/chkware.svg?style=social&label=Follow%20%40chkware)](https://twitter.com/chkware)
+> Test management for API era.
+
+### Introduction
+
+API tests management is not easy to develop, and maintain. It requires multitude of knowledge of programming libraries, business scenarios, infrastructure details, etc - unless you use ***chkware***.
+
+***chkware*** (pronounced as */check:ware/*) helps you write accurate, robust, and expressive feature tests for your API in less time.
+ 
+Read [more value propositions](introduction) here. Find [changelog](https://github.com/chkware/cli/blob/971e7400848f26f9f8d2be5fa9eef5fa80a6ded0/docs/CHANGELOG.md) here.
+
+### Setup
+
+With [**Python 3.10**](https://www.python.org/downloads/) and [**Pipx**](https://pypa.github.io/pipx/installation/#install-pipx) preinstalled, run following in your terminal to get ***chkware*** installed.
+
+```bash
+$ python -m pipx install chk
+```
+
+Jump to the [setup guide](setup) for different ways to install ***chkware***.
+
+### Usage
+
+[Get started](quick-start) quickly here.
+Find [More examples](examples) here
+
+### Contribute
+
+Read [contribution guide](https://github.com/chkware/cli/blob/971e7400848f26f9f8d2be5fa9eef5fa80a6ded0/docs/CONTRIBUTING.md) and [code of conduct](https://github.com/chkware/cli/blob/971e7400848f26f9f8d2be5fa9eef5fa80a6ded0/docs/CODE_OF_CONDUCT.md) to start contributions.
+
+---
+Licensed under [MPL v2.0](https://www.mozilla.org/en-US/MPL/2.0/) | Follow [@chkware](https://twitter.com/chkware) on Twitter | [`chk` project](https://pypi.org/project/chk/) on PyPi

docs/1.-introduction.md docs/01-introduction.mddocs/1.-introduction.md renamed to docs/01-introduction.md

@@ -1,52 +1,62 @@
 ---
-slug: /
 title: Introduction
-hide_title: true
 ---
 
-![Chkware | Test management for api era](./assets/github-hero-01.png)
+![chkware | Test management for api era](./assets/github-hero-01.png)
 
-**Chkware** is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
+**chkware** (pronounced as */check:ware/*) is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
 
 It is available as a command-line application. You write test specification files in a [YAML](https://yaml.org/)-based [DSL](https://en.wikipedia.org/wiki/Domain-specific_language). In that specification file you will define some structured configurations to be used for the following purpose:
 
-- Create reusable offline http request specification. [pre-released]
+- Create reusable http request specification. [alpha]
 - Create reusable test specifications. [TBD]
-- Create reusable test flows. [TBD]
-- Create reusable variable files to manage global and scoped data. [TBD]
 
 Afterward, you run those test specification files with **chkware**, and get test results or even reuse them.
 
 ---
 
 ### Motivation
 
-In today's world, API is one of the key fuels that drive business. It is the way web applications consume services from self-hosted or 3rd-party vendors. Recent technology movements are going to a fluid internet direction, where _vendor_A_ have one API, _vendor_B_ is another API provider, while we are the consumers (e-commerce, fin-tech) of those vendor APIs. We use those APIs to host our contents based on those APIs. Maybe we are _vendor_U_ hosting more complex APIs on top of those. So, with the upcoming complexity of integration we need better tooling for API testing. Testing tools for modularize api testing.
+In today's world, API is one of the key fuels that drive business. It is the way web applications consume services from self-hosted or 3rd-party vendors. Recent technology movements are going to a fluid internet direction, where *vendor_A* have one API, *vendor_B* is another API provider, while we are the consumers (e-commerce, fin-tech) of those vendor APIs. We use those APIs to host our contents based on those APIs. Maybe we are *vendor_U* hosting more complex APIs on top of those. So, with the upcoming complexity of integration we need better tooling for API testing. Testing tools for modularize api testing.
 
 API automation is playing a key role in this era. The benefits of API automation are clearly visible. There are plenty of tools to support all kinds of test automation. However, the complexity to create and maintain automated test cases using available tools is inescapable. No way it's quick to get started, or pick up without further education on the corresponding tools ecosystem. Furthermore, knowledge of the programming language that was used to develop the tools is also needed for advanced customization of test cases.
 
-API testing tools are costly as well, in-term of licensing, setup and maintenance. Some of the tools you are available for free for simple use-cases, have complex licensing for increased usage, most of the time that aren't worth user usage. Also, commercial applications have limited community support, and knowledge exchange medium. Above that, of course, there are less and less open-source tools to cover these scenarios.
+API testing tools are costly as well, in-term of licensing, setup and maintenance. Some tools are available for free for simple use-cases, but have complex licensing for increased usage, most of the time that aren't worthwhile. Also, commercial applications have limited community support, and knowledge exchange medium. Above that, of course, there are less and less open-source tools to cover these scenarios.
 
-For these reasons, the solutions are less scaling for actual use-cases. With additional business knowledge (that is ever growing) required to start and maintain tests, you also need:
+For these reasons, the solutions are less scaling for actual use-cases. With additional business knowledge (that is evergrowing) required to start and maintain tests, you also need:
 
-1. specific programming language knowledge, so it is not easy to jump-in quick
-2. added complexity of maintaining supporting software stack, so there are side-effects
+1. Specific programming language knowledge, so it is not easy to jump-in quick
+2. Added complexity of maintaining supporting software stack, so there are side effects 
 3. Above all, maintaining test cases based on code is more complex if you don't design your test code architecture well in the early days.
 
-So, clearly enough I think this situation needs to be improved. This is the motivation for **Chkware**.
+So, clearly enough I think this situation needs to be improved. This is the motivation for **chkware**.
 
 ---
 
 ### Audiences
 
-The focused users of chkware are everyone involved in an API project, given they have some testing basics.
+The focused users of **chkware** are everyone involved in an API project, given they have some testing basics. 
 
-- People with zero programming knowledge need a tool that does not get in their way.
-- We need a tool that is relatively easy to write specifications, expressive, and customizable to the very core.
+- People with zero programming knowledge need a tool that does not get in their way. 
+- We need a tool that is relatively easy to write specifications, expressive, and customizable to the very core. 
 - We need a tool that is very easy to learn, and fun to use.
 
 In practical cases, software testers / QAs, developers, PM/POs, are the people who should be able to use it rigorously.
 
 - This project is particularly helpful if you are developing an API oriented project.
 - Test websites or web interfaces are not in the project focus for now.
 - Also, seeding data, validating data in DB is out of this project scope for now.
+
+---
+
+### Platform support
+
+This tool is tested to run on **Linux**, **Windows**, and **macOS** platform.
+
+There is no native binary dependency, therefore it is expected on all the platform where supported Python version works. Please create an issue, if you need additional platform support.
+
+---
+
+### Stability
+
+Current stability for this tool is _Alpha_.

docs/2.-setup.md docs/02-setup.mddocs/2.-setup.md renamed to docs/02-setup.md

@@ -1,11 +1,12 @@
 ---
 title: Setup
-hide_title: true
 ---
 
 ### Installation
 
-The currently supported python version is **\*Python 3.8.\*\*** You need to have this version of python in your OS to continue any of the following steps.
+
+The currently supported python version is **_Python 3.10.x_** You need to have this version of python in your OS to continue any of the following steps.
+
 
 **Method 1: with pipx**
 
@@ -17,6 +18,12 @@ First, [Install pipx](https://pypa.github.io/pipx/installation/). Then run
 $ pipx install chk
 ```
 
+Then use as following
+
+```bash
+$ chk http SomeFile.chk
+```
+
 **Method 2: with pip (globally)**
 
 Alternatively you can install with `pip` like other regular python package following these step. However, it will install the package globally.
@@ -26,6 +33,12 @@ $ python3 -m pip install -U pip # upgrade pip
 $ python3 -m pip install -U chk
 ```
 
+Then use as following
+
+```bash
+$ python3 -m chk http SomeFile.chk
+```
+
 **Method 3: with pip (locally)**
 
 To install under a seperate environment, that don't change your global package space. Install under a virtual env.
@@ -37,6 +50,13 @@ $ pip install -U pip # upgrade pip
 $ pip install -U chk
 ```
 
+Then use as following
+
+```bash
+$ source .venv/bin/activate
+$ python -m chk http SomeFile.chk
+```
+
 ---
 
 ### Upgrade
@@ -48,15 +68,3 @@ $ pipx upgrade chk
 ```
 
 Otherwise, if **pip** was used to install then same process given above should work for upgrade as well.
-
----
-
-### Platform support
-
-For now this tool is developed and tested on **macOS** only. We are working hard to make it available on Linux platform.
-
----
-
-### Stability
-
-Current stability for this tool is _Pre - Alpha_

docs/3.-quick-start.md docs/03-quick-start.mddocs/3.-quick-start.md renamed to docs/03-quick-start.md

@@ -1,11 +1,10 @@
 ---
 title: Quick Start
-hide_title: true
 ---
 
 To quickly start, let's try something live online.. [REQ|RES](https://reqres.in) is a hosted demo REST api service. Let's call a simple API endpoint from here.
 
-> First [setup chkware](setup).
+> First [setup **chkware**](setup).
 
 Go to https://reqres.in, and find there is an endpoint like **_GET_ SINGLE USER** we'll call this API with Chkware. So, follow these steps:
 
@@ -22,7 +21,7 @@ request:
 3. from terminal run following
 
 ```bash
-$ chk User.chk
+$ chk http User.chk
 ```
 
 See the output like
@@ -66,7 +65,7 @@ request:
 
 ```bash
 $ cd ~/project
-$ chk covid-19.chk
+$ chk http covid-19.chk 
 ```
 
 1. You'll get output like this