README.md

circe

circe is a JSON library for Scala (and Scala.js).

Please see the guide for more information about why circe exists and how to use it.

Community

Adopters

Are you using circe? Please consider opening a pull request to list your organization here:

• Anduin Transactions
• AutoScout24
• BBC
• CiBO Technologies (using circe to (de)serialize data in support of a sustainable revolution in agriculture)
• Datalogue
• DriveTribe
• The Guardian
• HolidayCheck
• OVO Energy
• Project September (using circe to exchange and store data within the platform and serve data using GraphQL with Sangria)
• Ravel Law (using circe to (de)serialize data for search, analytics, and visualization of tens of millions of legal opinions)
• Reonomy
• Sigma
• Snowplow Analytics
• SoundCloud (transforming 200,000,000 JSON events every hour in MapReduce ETLs)
• Spotify (using circe for JSON IO in Scio)
• Stripe
• TabMo (parsing more than 100k events per second with Akka Stream and Spark)
• Threat Stack
• Twilio (sending many, many millions of messages a day with Circe and Akka)
• Zalando

Other circe organization projects

Please get in touch on Gitter if you have a circe-related project that you'd like to discuss hosting under the circe organization on GitHub.

• circe-benchmarks: Benchmarks for comparing the performance of circe and other JSON libraries for the JVM.
• circe-config: A library for translating between HOCON, Java properties, and JSON documents.
• circe-derivation: Experimental generic derivation with improved compile times.
• circe-fs2: A library that provides streaming JSON parsing and decoding built on fs2 and Jawn.
• circe-jackson: A library that provides Jackson-supported parsing and printing for circe.
• circe-spray: A library that provides JSON marshallers and unmarshallers for Spray using circe.
• circe-yaml: A library that uses SnakeYAML to support parsing YAML 1.1 into circe's Json.

Related projects

The following open source projects are either built on circe or provide circe support:

• Actor Messenger: A platform for instant messaging.
• akka-http-json: A library that supports using circe for JSON marshalling and unmarshalling in Akka HTTP.
• akka-stream-json: A library that provides JSON support for stream based applications using Jawn as a parser with a convenience example for circe.
• Argus: Generates models and circe encoders and decoders from JSON schemas.
• cornichon: A DSL for JSON API testing.
• Cosmos: An API for DCOS services that uses circe.
• crjdt: A conflict-free replicated JSON datatype in Scala.
• diffson: A Scala diff / patch library for JSON.
• elastic4s: A Scala client for Elasticsearch with circe support.
• Enumeratum: Enumerations for Scala with circe integration.
• Featherbed: A REST client library with circe support.
• Finch: A library for building web services with circe support.
• fintrospect: HTTP contracts for Finagle with circe support.
• fluflu: A Fluentd logger.
• Github4s: A GitHub API wrapper written in Scala.
• content-api-models: The Guardian's Content API Thrift models.
• http4s: A purely functional HTTP library for client and server applications.
• Iglu Schema Repository: A JSON Schema repository with circe support.
• jsactor: An actor library for Scala.js with circe support.
• jwt-circe: A JSON Web Token implementation with circe support.
• kadai-log: A logging library with circe support.
• msgpack4z-circe: A MessagePack implementation with circe support.
• play-circe: circe support for Play!.
• Rapture: Support for using circe's parsing and AST in Rapture JSON.
• roc: A PostgreSQL client built on Finagle.
• sangria-circe: circe marshalling for Sangria, a GraphQL implementation.
• scalist: A Todoist API client.
• scala-jsonapi: Scala support library for integrating the JSON API spec with Spray, Play! or Circe
• Scio: A Scala API for Apache Beam and Google Cloud Dataflow, uses circe for JSON IO
• seals: Tools for schema evolution and language-integrated schemata (derives circe encoders and decoders).
• Slick-pg: Slick extensions for PostgreSQL.
• sttp: Scala HTTP client.
• telepooz: A Scala wrapper for the Telegram Bot API built on circe.
• Zenith: Functional HTTP library built on circe.

Examples

The following projects provide examples, templates, or benchmarks that include circe:

• https://github.com/alanphillips78/akka-http-microservice-blueprint
• https://github.com/bneil/fcs_boilerplate
• https://github.com/gvolpe/simple-http4s-api
• https://github.com/vitorsvieira/akka-http-circe-json-template
• https://github.com/stephennancekivell/some-jmh-json-benchmarks-circe-jackson

Contributors and participation

circe is a fork of Argonaut, and if you find it at all useful, you should thank Mark Hibberd, Tony Morris, Kenji Yoshida, and the rest of the Argonaut contributors.

circe is currently maintained by Travis Brown, Alexandre Archambault, and Vladimir Kostyukov. After the 1.0 release, all pull requests will require two sign-offs by a maintainer to be merged.

The circe project supports the Typelevel code of conduct and wants all of its channels (Gitter, GitHub, etc.) to be welcoming environments for everyone.

Please see the contributors' guide for details on how to submit a pull request.

License

circe is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.