Permalink
Browse files

Updated overview with code layout info

Removed friends.json to put it into private/public bookmarks system
Updated config.py
Removed main gitmark object from gitmark_add.py and moved it to getmark.py
Added "we use HTTPS" note to delicious_import.py help
Started basic code for gitmark_friend usage.
Started services.json file for services we know how to use
  • Loading branch information...
1 parent 40a734a commit a01841e7d1901f74f45a857e465ca8ac0d8765aa @FarMcKon committed Apr 3, 2011
Showing with 494 additions and 352 deletions.
  1. +20 −0 OVERVIEW
  2. +5 −0 config.py
  3. +2 −2 delicious_import.py
  4. 0 friends.json
  5. +370 −0 gitmark.py
  6. +4 −349 gitmark_add.py
  7. +89 −1 gitmark_friend.py
  8. +4 −0 services.json
View
@@ -67,4 +67,24 @@ Brass: Filesystem:
/posted - encrypted bookmarks 'sent' from friends (public key if to/from other users)
- /content - (optional) local content (scraped pages, stats, info, tags info, etc) (can be synced to git repo type C)
+
+=====
+Python Code Layout
+=====
+
+The main classes and code are as follows:
+
+ gitmark.py
+ - class gitmark:
+ Class represents a single gitmark and it's stats and metadata.
+ - class gitmarkRepoSyncer:
+ Calss contains tools for managing remote <-> local repositories
+ Most of this is automated into a simple 'fetch, merge, check for changes, push'
+
+ gitmark_add.py
+ No class, this is a command line file to add gitmarks to the repository.
+
+ gitmark_friend.py
+ No class, this is a command line file to check for friends updates.
+
View
@@ -20,6 +20,11 @@
USE_SHELL = os.name == 'nt'
def configure_gitmarks():
+ """
+ This funcion does the basic configuration of gitmarks. It tries to download
+ needed software, get settings from users, and spawns the basic on-disk files for
+ the bookmarks.
+ """
# -- pull needed libraries from the net
download_needed_software()
View
4 delicious_import.py 100644 → 100755
@@ -112,7 +112,7 @@ def import_delicious_to_local_git(username, password='', url=None):
addToRepo(newMarksList[0],doPush=False)
# -- hack test main for when yahoo sucks and I need to test
-if __name__ == '__fmain__':
+if __name__ == '__offfline_main__':
x = { "extended": "",
@@ -147,7 +147,7 @@ def import_delicious_to_local_git(username, password='', url=None):
if __name__ == '__main__':
- usage = "Usage: python delicious_import.py cached-page-uri\nOR\nUsage: python delicious_import.py username password"
+ usage = "Usage: python delicious_import.py cached-page-uri\nOR\nUsage: python delicious_import.py username password\n***Password and username are sent as HHTTPS***"
if( len(sys.argv) == 2):
import getpass
View
No changes.
Oops, something went wrong.

0 comments on commit a01841e

Please sign in to comment.