25f994d7f53acecc5af837a5b69308a3b63ae3a6 — cevado 8 months ago c8b9738
Update readme
3 files changed, 180 insertions(+), 0 deletions(-)

@@ 0,0 1,4 @@
# Changelog

## v0.0.1 - 2022-07-04
 * First public release 

@@ 0,0 1,134 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
  and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
  any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
  without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
  professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

M README.md => README.md +42 -0
@@ 0,0 1,42 @@
# Boto
Boto is an attempt to provide features similar to what [Pathom](https://pathom3.wsscode.com/) provides to Clojure/Clojurescript.

The core concept behind Boto is that you won't have to think of entities anymore, you only need to care about the data that you already have and the data that you need.
Boto will take care of trying to retrieve all the data that you need, based on resolvers that you registered.
Imagine something like graphql but inside your code, that can leverage any source of information that you can reach.

## Work in progress
Boto is still in development and there is a lot of work to be done for it to be as useful as it can be.
There are some considerations on current behaviour:
- All resolvers are called in a single process, even for nested attributes.
- Currently queries are optimistic, what means that if Boto can't resolve everything you queried it gonna return everything it was able to retrieve.
- For this first experiment, I'm not handling errros for resolvers. So it's just expected for the resolvers to return data correctly.

If those behaviors will be kept or changed, it's open to discussion.

## [Current Roadmap](https://codeberg.org/cevado/boto/projects/1554)
- [i] Document the entire codebase.
- [i] Full test coverage of complex scenarios and unit tests.
- [d] Handle resolvers failures, with configurable retries.
- [d] Failure state when it's not possible to retrieve all data queried.
- [d] Additional parameter to nested queries.
- [d] Filters for nested attributes that return N entries.
- [c] Paralelize resolvers.
- [c] Cache with TTL for results.
[d]: discussion
[c]: confirmed
[i]: in progress
[x]: done

## [Examples](examples/)
There are two examples available, both in Elixir and Erlang, showing some scenarios of how to use the library.
The simple one is the weather resolver, that can get the current temperature forecast for a given ip, if no ip is provided it gonna use your own ip as resource.
The elaborated example is the Hacker News api resolver, that can query the public Hacker News api, including nested resources.
There is also a livemd file that you can open with [Livebook](https://livebook.dev/) to explore the library usage.

## Contributing
The source of truth for this code is [codeberg](https://codeberg.org/cevado/boto), provide feedback and join discussion in the issues.
A mirror is kept in [sourcehut](https://git.sr.ht/~cevado/boto).
You're welcomed to interact on both places.
Check the [code of conduct](CODE_OF_CONDUCT.md).