From b6d55da74fdbc774ca2998cd2e213d36fe18642f Mon Sep 17 00:00:00 2001 From: David Todd Date: Sat, 18 Jan 2020 19:53:23 -0600 Subject: [PATCH] Initial Commit --- .editorconfig | 13 +++++++++++++ .gitignore | 4 ++++ LICENSE.md | 7 +++++++ README.md | 15 +++++++++++++++ 4 files changed, 39 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..57b1b85 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.yaml] +indent_style = space +indent_size = 2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bdc9181 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +*.db +*pycache* +*.lock +*~ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..ca71648 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright 2020 - David Todd (c0de@c0defox.es) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..553b74f --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# A simple bookmarking engine + +This is a small python3 API and website that allows saving bookmarks into an SQLite3 database. + +The production environment will eventually be hosted at [save.c0de.link](https://save.c0de.link) + +## Completed Features: +* Database - Capable of any user-defined database file (multiple instances); Has Create/Read/Update/Delete methods for bookmarks + +## Upcoming Features (TODO): +* Authentication - I'm thinking about using [Telethon](https://github.com/LonamiWebs/Telethon) which will send me auth tokens, which would then be sent along with the request +* Website UI - I want the website to be extremely easy to use. I plan on using [Bootstrap 4](https://getbootstrap.com/) with a style very similar to [lob.li](https://lob.li) +* API - Able to accept various HTTP methods (POST, GET for sure, possibly PUT and DELETE). This will interface with the database, and provide data sanitization. I'm planning on using [Bottle](https://bottlepy.org/docs/dev/) to accomplish this +* Chrome Extension - This will allow exporting bookmarks from Chrome into this service, as well as quickly adding pages, most likely through a right click menu and by clicking on the icon +* Firefox Extension - Everything the Chrome extension can do