Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbohdan/jimhttp
A library collection and web microframework
https://github.com/dbohdan/jimhttp
http jim-tcl json libraries redis-client tcl valkey-client web-framework
Last synced: 3 months ago
JSON representation
A library collection and web microframework
- Host: GitHub
- URL: https://github.com/dbohdan/jimhttp
- Owner: dbohdan
- License: mit
- Created: 2014-09-16T10:07:02.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T16:10:17.000Z (9 months ago)
- Last Synced: 2024-05-17T14:37:52.438Z (8 months ago)
- Topics: http, jim-tcl, json, libraries, redis-client, tcl, valkey-client, web-framework
- Language: Tcl
- Homepage: https://wiki.tcl-lang.org/page/jimhttp
- Size: 238 KB
- Stars: 28
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jimhttp
A collection of standalone libraries and a web microframework prototype for [Jim Tcl](http://jim.tcl-lang.org/).
Most of the libraries also work in Tcl 8.5–9.
The libraries implement command-line and proc argument parsing, an HTML DSL, parsing and generating JSON, templates, and persistent storage
powered by SQLite 3.
The web microframework provides a rough implementation of the HTTP/1.1 protocol and a routing DSL.
## Components
The components listed below work in Tcl 8.5, 8.6, 9.0b2rc2, and Jim Tcl 0.76 and later unless indicated otherwise.
Each component is versioned separately.
Component version numbers follow [semantic versioning](http://semver.org/spec/v2.0.0.html).
A major version number of zero indicates an unstable API.
| Filename | Function | Version |
|----------|----------|---------|
| [arguments.tcl](arguments.tcl) | Command line argument parsing. | 1.0.0 |
| [example.tcl](example.tcl) 1 | A sample web server that demonstrates the use of the other components. | — |
| [entities.tcl](entities.tcl) | A dictionary mapping characters to HTML entities. | 1.0.0 |
| [html.tcl](html.tcl) | A DSL for generating HTML. Requires entities.tcl. | 0.2.1 |
| [http.tcl](http.tcl) 1 | The titular web microframework. Requires mime.tcl. | 0.15.2 |
| [json.tcl](json.tcl) | JSON generation with schema support. 3 JSON parsing. 4 | 3.0.0 |
| [mime.tcl](mime.tcl) | Rudimentary MIME type detection based on the file extension. | 1.2.0 |
| [rejim.tcl](rejim.tcl) 2 | A basic RESP2 Redis/Valkey/KeyDB/etc. client. | 0.2.0 |
| [storage.tcl](storage.tcl) 1 | SQLite persistence of static variables. | 0.2.0 |
| [template.tcl](template.tcl) | [tmpl_parser](https://wiki.tcl-lang.org/20363) templating. | 1.0.0 |
| [testing.tcl](testing.tcl) | A test framework with support for tcltest-style constraints. | 0.5.0 |
| [tests.tcl](tests.tcl) | Tests for the other components. 5 | — |
1\. Jim Tcl-only.
2\. Does not support Tcl 8.5.
3\. Schemas define data shapes. See the example below.
4\. **Warning:** parsing is fairly slow in general and extremely slow in UTF-8 builds of Jim Tcl.
([Obsolete benchmark](https://wiki.tcl-lang.org/48500).)
This can matter to you if you need to decode more than a few dozen kilobytes of JSON at a time.
Since version 0.79, Jim Tcl can be built with a fast binary extension for parsing and encoding JSON.
The [jq module](https://wiki.tcl-lang.org/11630) is an option for faster JSON parsing in earlier versions.
It requires an external binary.
5\. Only compatible components are tested in Tcl 8 and 9.
## Use examples
### http.tcl
```Tcl
source http.tcl
::http::add-handler GET /hello/:name/:town {
::http::respond [::http::make-response \
"Hello, $routeVars(name) from $routeVars(town)!"]
}
::http::start-server 127.0.0.1 8080
```
### http.tcl and storage.tcl
```Tcl
source http.tcl
source storage.tcl
::http::add-handler GET /counter-persistent {{counter 0}} {
::storage::restore-statics
incr counter
::storage::persist-statics
::http::respond [::http::make-response $counter]
}
::storage::init
::http::start-server 127.0.0.1 8080
```
### json.tcl
```Tcl
# This produces the output
# {"a": "123", "b": 123, "c": [123, 456], "d": "true", "e": true}
source json.tcl
puts [::json::stringify {
a 123
b 123
c {123 456}
d true
e true
} 0 {
a string
c {*element* number}
d string
}]
```
## Requirements
Compile Jim Tcl 0.76 or later from its Git repository.
Stable releases prior to that (0.75 and earlier) will not work.
You will need an SQLite 3 development package
(`libsqlite3-dev` on Debian and Ubuntu, `libsqlite3x-devel` on Fedora, `sqlite3-devel` on openSUSE Tumbleweed)
to do this
and optionally AsciiDoc
(`asciidoc` on Debian and Ubuntu, Fedora, and openSUSE)
to generate the documentation (don't use the option `--disable-docs` if you want it).
```sh
git clone https://github.com/msteveb/jimtcl.git
cd jimtcl
./configure --with-ext="oo tree binary sqlite3" --enable-utf8 --ipv6 --disable-docs
make
sudo make install
```
Once you have installed Jim Tcl, you can clone this repository and try out the example by running
```sh
git clone https://github.com/dbohdan/jimhttp.git
cd jimhttp
jimsh example.tcl
```
and then pointing your web browser to .
## License
MIT.
[entities.tcl](entities.tcl)
is copyright 1998–2000 Ajuba Solutions and copyright 2006 Michael Schlenker.
It is distributed under the Tcl license.
See the top comment in the file.
`static.jpg` photo by [Steven Lewis](http://notsteve.com/).
License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/).