Skip to content

WIP add Livebook examples in documentation #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
timgremore wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP add Livebook examples in documentation #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# AsanaEx

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
Expand All @@ -15,7 +13,32 @@ def deps do
end
```

<!-- livebook:{"force_markdown":true} -->
### Fetch details about self, including workspace gids
```elixir
{:ok, me} = AsanaEx.Client.me(token)
my_gid = me["data"]["gid"]
workspace_gids = Enum.map(me["data"]["workspaces"], fn %{"gid" => gid} -> gid end)
```
<!-- livebook:{"force_markdown":true} -->
### Fetch all tasks for a collection of workspace gids or a single workspace gid:
```elixir
tasks =
AsanaEx.Client.all_workspace_tasks(workspace_gids, my_gid, token)
|> Enum.to_list()
|> Enum.flat_map(fn {:ok, tasks} -> tasks end)
```

<!-- livebook:{"force_markdown":true} -->
### Fetch subtasks for tasks:
```elixir
subtasks =
AsanaEx.Client.maybe_get_subtasks(tasks, my_gid, token)
|> Enum.to_list()
|> Enum.flat_map(fn {:ok, tasks} -> tasks end)
|> Enum.map(& &1["name"])
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/asana_ex](https://hexdocs.pm/asana_ex).