neocities-clj.core — org.clojars.twsio/neocities-clj 0.1.0

api-path clj

api-url clj

delete clj

(delete paths & {:keys [api-key user pass] :or {api-key nil user nil pass nil}})

Deletes files with the given paths.

domain clj

info clj

(info & {:keys [api-key user pass] :or {api-key nil user nil pass nil}})

Retrieves information about a site. You can give the site/user name without password and it will return the info, or with credentials it will give the info about that user's site.

key clj

(key user pass)

Returns an API key that you can use for the API instead of login credentials. It will automatically generate a new API key if one doesn't exist yet for your site. Similarly to list, it's expected to use the namespace so it doesn't overlap with the standard key, or rename the function.

list clj

(list {:keys [api-key user pass path]
       :or {api-key nil user nil pass nil path nil}})

Provides a list of files on your site. If you provide a path it will list all of the files in that directory. It's expected you'll use a namespace alias so it doesn't overlap with the standard library's list. Something like neo/list. You could also rename it in the require like (require '[neocities-clj.core :rename {list neo-list}]).

set-credentials clj

(set-credentials user pass)

A helper function that when given credentials, returns all of the functions with the credentials set.

set-key clj

(set-key api-key)

Convenience function to set the API key in functions requiring credentials.

upload clj

(upload paths & {:keys [api-key user pass] :or {api-key nil user nil pass nil}})

Given a map of server paths to local file paths, uploads those local files to the corresponding server paths.