Developer documentation for Retriever Julia package

Before you begin, make sure you have the retriever python package installed. Read about the Pkg REPL

All required packeges

These packages will be installed once the Retriever.jl package is installed

PyCall Compat DocStringExtensions Documenter MySQL Pkg SQLite Test JuliaFormatter

PyCall

Pycall julia is used to communicate with the retriever python package objects.

Documenter

Documenter tool is used for building documentation To test the documentations locally, install the current source

julia> include("src/Retriever.jl")

Tests

Use Pkg REPL in the main directory

pkg> test

Linter

julia> using JuliaFormatter

# Recursively formats all Julia files in the current directory
julia> format(".")

# Formats an individual file
julia> format_file("foo.jl")

Register and Release Retriever

julia> ENV["PYTHON"]="Python path where retriever python package is installed"
julia> Pkg.build("PyCall")
julia> Pkg.add("PyCall")
julia> Pkg.test("Retriever")
julia> Pkg.update()
julia> Pkg.add("PkgDev")
julia> using  PkgDev

julia> PkgDev.register("Retriever")
INFO: Registering Retriever at https://github.com/weecology/Retriever.jl.git
INFO: Committing METADATA for Retriever

julia> PkgDev.tag("Retriever")
INFO: Tagging Retriever v0.0.1

julia> PkgDev.config()
PkgDev.jl configuration:
User name: provide git user name
User email: provide git associated email
Enter GitHub user [Defualt name]:
Do you want to change this configuration? [N]:N

julia> PkgDev.publish()
INFO: Validating METADATA
INFO: Creating a personal access token for Julia Package Manager on GitHub.
	You will be asked to provide credentials to your GitHub account.

...Git Credential authentication

INFO: Pushing Retriever permanent tags: v0.0.1
INFO: Submitting METADATA changes
INFO: Forking JuliaLang/METADATA.jl to henrykironde
INFO: Pushing changes as branch pull-request/ceea745c
INFO: To create a pull-request, open:

  https://[link to the Branch created]