Skip to content

Commit 8a27c24

Browse files
antoniorodrantoniorodr
committed
release v0.3.1
1 parent 75613cd commit 8a27c24

File tree

9 files changed

+182
-1
lines changed

9 files changed

+182
-1
lines changed

‎.github/workflows/ci.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Configure Git Credentials
15+
run: |
16+
git config user.name github-actions[bot]
17+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: 3.x
21+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
22+
- uses: actions/cache@v4
23+
with:
24+
key: mkdocs-material-${{ env.cache_id }}
25+
path: .cache
26+
restore-keys: |
27+
mkdocs-material-
28+
- run: pip install mkdocs-material
29+
- run: mkdocs gh-deploy --force

‎CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [0.3.1] - 03.05.2025
6+
7+
### Added
8+
9+
- Material for MkDocs support for the documentation.
10+
11+
### Changed
12+
13+
- Small changes and updates to the README file.
14+
515
## [0.3.0] - 23.04.2025
616

717
### Added
@@ -95,6 +105,7 @@ Initial release with core Apple Notes functionality:
95105
- Move notes between folders
96106
- List all folders and subfolders
97107

108+
[0.3.1]: https://github.com/antoniorodr/memo/releases/tag/v0.3.1
98109
[0.3.0]: htpps://github.com/antoniorodr/memo/releases/tag/v0.3.0
99110
[0.2.3]: https://github.com/antoniorodr/memo/releases/tag/v0.2.3
100111
[0.2.2]: https://github.com/antoniorodr/memo/releases/tag/v0.2.2

‎docs/.nav.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
nav:
2+
- index.md
3+
- Installation.md
4+
- Getting started.md

‎docs/Getting started.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Be careful when using --edit and --move flags with notes that include images/attachments. Memo does not support this yet. Memo will send you a warning if you try to edit a note with images/attachments.
2+
3+
Use the command `memo notes --help` to see all the options available for notes.
4+
5+
```bash
6+
memo notes --help
7+
Usage: memo notes [OPTIONS]
8+
9+
Options:
10+
-f, --folder TEXT Specify a folder to filter the notes (leave empty to get
11+
all).
12+
-a, --add Add a note to the specified folder. Specify a folder
13+
using the --folder flag.
14+
-e, --edit Edit a note in the specified folder. Specify a folder
15+
using the --folder flag.
16+
-d, --delete Delete a note in the specified folder. Specify a folder
17+
using the --folder flag.
18+
-m, --move Move a note to a different folder.
19+
-fl, --flist List all the folders and subfolders.
20+
-s, --search Fuzzy search your notes.
21+
-r, --remove Remove the folder you specified.
22+
-ex, --export Export your notes to the Desktop.
23+
--help Show this message and exit.
24+
```
25+
26+
Use the command `memo rem --help` to see all the options available for reminders.
27+
28+
```bash
29+
memo rem --help
30+
Usage: memo rem [OPTIONS]
31+
32+
Options:
33+
-c, --complete Mark a reminder as completed.
34+
-a, --add Add a new reminder.
35+
-d, --delete Delete a reminder.
36+
--help Show this message and exit.
37+
```
38+
39+
You can use `memo --help` to see the available commands.
40+
41+
```bash
42+
memo --help
43+
Usage: memo [OPTIONS] COMMAND [ARGS]...
44+
45+
Options:
46+
--version Show the version and exit.
47+
--help Show this message and exit.
48+
49+
Commands:
50+
notes
51+
rem
52+
```
53+
54+
Memo uses `$EDITOR` to edit and add notes. You can set it up by running the following command:
55+
56+
```bash
57+
export EDITOR="vim"
58+
```
59+
60+
Where `vim` can be replaced with your preferred editor. Add it to your .zshrc/.bashrc to make it permanent.
61+
62+
Or check the one you have set up in your terminal by running:
63+
64+
```bash
65+
echo $EDITOR
66+
```

‎docs/Installation.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#### Manual Installation
2+
3+
```bash
4+
git clone https://github.com/antoniorodr/memo
5+
6+
cd memo
7+
8+
pip install .
9+
```
10+
11+
#### Homebrew Installation
12+
13+
```bash
14+
brew tap antoniorodr/memo
15+
brew install antoniorodr/memo/memo
16+
```

‎docs/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Welcome to Memo's documentation
2+
3+
## About
4+
5+
**Memo** is a simple command-line interface (CLI) tool for managing your Apple Notes and Apple Reminders. It’s written in Python and aims to offer a fast, keyboard-driven way to create, search, and organize notes and reminders straight from your terminal.
6+
7+
## Demo
8+
9+
[![asciicast](https://asciinema.org/a/711983.svg)](https://asciinema.org/a/711983)

‎docs/memo.png

2.52 MB
Loading

‎mkdocs.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
site_name: Memo
2+
site_url: https://mydomain.org/memo
3+
repo_url: https://github.com/antoniorodr/memo
4+
repo_name: Memo
5+
edit_uri: edit/main/docs/
6+
theme:
7+
name: material
8+
logo: memo.png
9+
icon:
10+
repo: fontawesome/brands/github
11+
favicon: memo.png
12+
features:
13+
- navigation.instant
14+
- navigation.instant.prefetch
15+
- navigation.instant.progress
16+
- search.suggest
17+
- navigation.footer
18+
- navigation.path
19+
- navigation.top
20+
palette:
21+
- scheme: default
22+
primary: amber
23+
accent: amber
24+
toggle:
25+
icon: material/brightness-7
26+
name: Switch to dark mode
27+
28+
- scheme: slate
29+
primary: amber
30+
accent: amber
31+
toggle:
32+
icon: material/brightness-4
33+
name: Switch to light mode
34+
primary: amber
35+
accent: amber
36+
plugins:
37+
- search
38+
- awesome-nav
39+
extra:
40+
social:
41+
- icon: fontawesome/brands/github
42+
link: https://github.com/antoniorodr
43+
copyright: Copyright © 2025 - Antonio Rodriguez

‎pyproject.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
55
[project]
66
name = "memo"
77
authors = [{ name = "Antonio Rodriguez", email = "[email protected]" }]
8-
version = "0.3.0"
8+
version = "0.3.1"
99
description = "CLI app to manage your Apple Notes and Apple reminders"
1010
readme = "README.md"
1111
license = "MIT"
@@ -27,3 +27,6 @@ memo = "memo.memo:cli"
2727

2828
[tool.setuptools]
2929
package-dir = { "" = "src" }
30+
31+
[tool.pytest.ini_options]
32+
pythonpath = [".", "src"]

0 commit comments

Comments
 (0)