Re: Noob guidelines for writing a new package?

[Jacob Quinn]

I would check out the documentation on modules (as they play a big part in managing namespace): http://docs.julialang.org/en/latest/manual/modules/

Then check out the Metadata.jl repo to see how other packages are put together: https://github.com/JuliaLang/METADATA.jl

The readme on Metadata.jl has the main bulk of information on putting together packages. 

You can also check out the 'Example' package which was put together for this exact purpose: https://github.com/JuliaLang/METADATA.jl/tree/master/Example

There's also more info by searching this group:

https://groups.google.com/forum/?fromgroups=#!searchin/julia-dev/new$20package/julia-dev/R4kuLmBfRv4/NEpXjRhP0OkJ

And checking out the related StackOverflow question: http://stackoverflow.com/questions/14092316/simplest-ways-to-make-a-julia-package-available-to-others

On Thursday, March 21, 2013 10:49:32 AM UTC-5, Jiahao Chen wrote:

Hi all,

I am new to Julia and trying to put together some functions into a new package. However, I am having trouble finding documentation on how packages are formatted and submitted to the master package repo.

Would appreciate pointers to up-to-date documentation or step-by-step instructions in how to write the necessary METADATA, etc.

Thanks,

Jiahao Chen

MIT Chemistry

[Viral Shah]

It would be really great if someone can submit a pull request adding package creation steps to CONTRIBUTING.md. 

-viral

[Patrick O'Leary]

Also take a look at Pkg.new(), which creates a skeleton. Correct METADATA can be written with functions available in Pkg as well (pkg_origin() and major()/minor()/patch()).

[Jacob Quinn]

What about a 'Packages' page in the documentation manual? That's probably the most central, most-viewed location. It could cover Pkg basics, adding, updating, and then have a later section that covers basic package creations steps and includes a few relevant links.

-Jacob

[Viral Shah]

The Packages page in the manual would be for users to use packages, which is also needed. We do not really have documentation for developers yet, which is why I suggested adding it to CONTRIBUTING.md for now.

-viral

[John Myles White]

I think writing a package is somewhere in between being a user of Julia and being a developer, so I'd support putting a Package Writing section in the manual.

-- John

[Gustavo Lacerda]

So I'm writing my first package.
Are there guidelines on where to put example code? Can it go on the
same .jl file as the essential code?

Gustavo

[Gustavo Lacerda]

I now see that http://docs.julialang.org/en/latest/manual/packages/
answers my question!
Thanks!

Gustavo