Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliaweb/mimes.jl
MIME information: filetype, encoding, gzip
https://github.com/juliaweb/mimes.jl
julia web
Last synced: 3 months ago
JSON representation
MIME information: filetype, encoding, gzip
- Host: GitHub
- URL: https://github.com/juliaweb/mimes.jl
- Owner: JuliaWeb
- License: mit
- Created: 2022-03-21T21:33:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T09:42:09.000Z (4 months ago)
- Last Synced: 2024-11-05T10:34:54.709Z (4 months ago)
- Topics: julia, web
- Language: Julia
- Homepage:
- Size: 189 KB
- Stars: 9
- Watchers: 5
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MIMEs.jl
A small package to transform between file extensions and MIME types, with bonus features.
# Examples
```julia
julia> using MIMEs
### For filename extensions:
julia> m = mime_from_extension(".json")
MIME type application/json
julia> extension_from_mime(m)
".json"
### For web servers:
julia> compressible_from_mime(m) # whether content of this MIME can/should be gzipped
true
julia> charset_from_mime(m)
"UTF-8"
julia> contenttype_from_mime(m) # the Content-Type HTTP header
"application/json; charset=utf-8"
julia> mime_from_contenttype("application/json; charset=utf-8")
MIME type application/json
```
# Implementation
This package uses the popular [jshttp/mime-db](https://github.com/jshttp/mime-db) database. This database is an aggregation of the following sources:
- https://hg.nginx.org/nginx/raw-file/default/conf/mime.types
- https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
- https://www.iana.org/assignments/media-types/media-types.xhtml
The function implementations, including resolution for conflicting extensions (nginx > apache > mime-db > IANA), is based on [jshttp/mime-types](https://github.com/jshttp/mime-types).
## Performance
The database is parsed and processed by us, and written directly to the source code (see #3). This means that the package has no dependencies, and loads very fast:
```julia
julia> @time import MIMEs; MIMEs.mime_from_path("a/foo.txt")
0.023083 seconds (36.38 k allocations: 3.107 MiB, 39.83% compilation time)
```
## Opinions
While mostly cold and technical, this package contains a couple of opinionated choices:
- We use multiple sources for MIME information, and when these sources have conflicting/duplicate information, we
- `text/javascript` is used for `.js` and `.mjs` files, not `application/javascript`. This transition is still underway in official channels, but @fonsp prefers to start using `text/javascript` today. [More info →](https://github.com/jshttp/mime-db/issues/194)
- `text/julia` is used for `.jl` files. This MIME is not (yet) official: [More info →](https://github.com/JuliaWeb/MIMEs.jl/issues/4)
# See also
* [tkf/MIMEFileExtensions.jl](https://github.com/tkf/MIMEFileExtensions.jl): Similar smaller package based on the Apache database, for MIME <-> extension conversion only. MIMEs.jl also contains additional MIME-related queries useful for writing servers.
* [JuliaIO/FileType.jl](https://github.com/JuliaIO/FileType.jl): File type (including MIME) detection based also on the file content.
# Future development & scope
Future goals of MIMEs.jl:
- All things MIME! If you are writing a web application in Julia and you are missing MIME-related functionality, let us know! Issues and Pull Requests are welcome.
- This package will be regularly updated to match the (monthly) updates to [jshttp/mime-db](https://github.com/jshttp/mime-db). Right now this is involves manually running the update script, but we might automate this in the future. [More info →](https://github.com/JuliaWeb/MIMEs.jl/issues/1)