Skip to content

Commit

Permalink
Tag v0.1.3.
Browse files Browse the repository at this point in the history
  • Loading branch information
markpbaggett committed Jan 10, 2020
1 parent 9f7c859 commit 547a5b3
Show file tree
Hide file tree
Showing 9 changed files with 147 additions and 52 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ Installing and Building

Moldy Bread is designed to be as portable as possible by being compiled in C.

The latest tagged release is available in `releases <https://github.com/markpbaggett/moldybread/releases>`_ and compiled with gcc. Depending on your architecture,
you may be able to use the binary available here.
The latest tagged release is available in `releases <https://github.com/markpbaggett/moldybread/releases>`_ and compiled with gcc. Depending on your architecture (X86 64Bit Linux),
you may be able to use the binary available here.

For security reasons, no authentication information is stored in the compiled version of the binary.
For security reasons, no authentication information is stored in the compiled version of the binary.

For this reason, you must point at a config.yml file. For more information about this, `review the documentation <https://markpbaggett.github.io/moldybread/moldybread.html#defining-a-configdotyml>`_.

**Building the Application**

If you are unable to use the release binrary, you can build a binary with the files in this repository.

1. First, follow the instrucitons here to install nim.
1. First, follow the instructions `here <https://nim-lang.org/install.html>`_ to install nim. Using choosenim is recommended.
2. Make sure you set your PATH appropriately so that nim and nimble can be found.
3. Make sure you have a c compiler like gcc or musl (if not, you'll get an error in step 6).
4. git clone git@github.com:markpbaggett/moldybread.git
Expand All @@ -38,6 +38,6 @@ If you are unable to use the release binrary, you can build a binary with the fi
Documentation
-------------

Documentation for all packages and public procs and types are generated automatically and hosted on `GitHub Pages <https://markpbaggett.github.io/moldybread/moldybread.html>`_ after each commit.
Documentation for all packages and public procs and types are generated automatically and hosted in this repository with `GitHub Pages <https://markpbaggett.github.io/moldybread/moldybread.html>`_ after each commit.

Look here for instructions on how to use any piece of Moldy Bread.
Look here for instructions on how to use all operations.
2 changes: 1 addition & 1 deletion changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Moldy Bread Change Log
======================

0.1.3 - Upcoming (Not Yet Tagged)
0.1.3 - January 10, 2019
=================================

**Bug Fixes**:
Expand Down
9 changes: 7 additions & 2 deletions docs/moldybread.html
Original file line number Diff line number Diff line change
Expand Up @@ -837,6 +837,7 @@ <h1 class="title">MOLDY BREAD</h1>
<li><a class="reference" id="find-objects-missing-a-particular-datastream_toc" href="#find-objects-missing-a-particular-datastream">Find Objects Missing a Particular Datastream</a></li>
<li><a class="reference" id="download-datastream-histories-as-xml_toc" href="#download-datastream-histories-as-xml">Download Datastream Histories as XML</a></li>
<li><a class="reference" id="download-datastream-at-date_toc" href="#download-datastream-at-date">Download Datastream at Date</a></li>
<li><a class="reference" id="download-all-versions-of-a-datastream_toc" href="#download-all-versions-of-a-datastream">Download All Versions of a Datastream</a></li>
<li><a class="reference" id="validate-checksums_toc" href="#validate-checksums">Validate Checksums</a></li>
<li><a class="reference" id="find-unique-datastreams_toc" href="#find-unique-datastreams">Find Unique Datastreams</a></li>
<li>
Expand All @@ -855,8 +856,9 @@ <h1 class="title">MOLDY BREAD</h1>
<p class="module-desc"><p>This package allows users to interact with a Fedora 3.8 repository via the CLI.</p>
<p>The instructions here assume you are working with a compiled version of Moldy Bread. See installation instructions or package info if you are looking for something else.</p>

<h1><a class="toc-backref" id="defining-a-configdotyml" href="#defining-a-configdotyml">Defining a config.yml</a></h1><p>Make a copy of default_config.yml as config.yml and set settings appropriately. Currently, this is the only way to pass authentication information for Fedora and Gsearch.</p>
<h1><a class="toc-backref" id="defining-a-configdotyml" href="#defining-a-configdotyml">Defining a config.yml</a></h1><p>Make a copy of default_config.yml and set settings appropriately. Currently, this is the only way to pass authentication information for Fedora and Gsearch.</p>
<p>You can store this config file anywhere that you have read permissions. Use the full path to the file in commands like in the examples below.</p>
<p>Optionally, as of v0.1.2 you can avoid passing the -y flag on requests by including a directory called config with your yaml as config.yml in the path from where you are executing your command.</p>

<h1><a class="toc-backref" id="command-line-parsing" href="#command-line-parsing">Command Line Parsing</a></h1><p>When in doubt, use help:</p>
<pre class="listing">
Expand Down Expand Up @@ -922,6 +924,9 @@ <h1><a class="toc-backref" id="download-datastream-at-date" href="#download-data
<p>Example command:</p>
<pre class="listing">
moldybread -o get_datastream_at_date -n test -d RELS-EXT -dt 2019-12-19 -y /full/path/to/my/yaml/file.yml</pre>
<h1><a class="toc-backref" id="download-all-versions-of-a-datastream" href="#download-all-versions-of-a-datastream">Download All Versions of a Datastream</a></h1><p>You can download all versions of a datastream for a results set and have it serialized as pid-datestampe.extension (test:4-2020-01-07T16:18:28.742Z.xml).</p>
<pre class="listing">
moldybread -o download_all_versions -d MODS -t Vancouver -y /full/path/to/my/yaml/file.yml</pre>
<h1><a class="toc-backref" id="validate-checksums" href="#validate-checksums">Validate Checksums</a></h1><p>You can check whether the current checksum of a datastream for an object matches the original checksum. If not, the objects with bad datastreams are listed:</p>
<p>Example command:</p>
<pre class="listing">
Expand All @@ -946,7 +951,7 @@ <h1><a class="toc-backref" href="#6">Imports</a></h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2020-01-06 01:46:36 UTC</small>
<small>Made with Nim. Generated: 2020-01-10 13:48:47 UTC</small>
</div>
</div>
</div>
Expand Down
1 change: 1 addition & 0 deletions docs/moldybread.idx
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Purge Old Versions of a Datastream moldybread.html#purge-old-versions-of-a-datas
Find Objects Missing a Particular Datastream moldybread.html#find-objects-missing-a-particular-datastream Find Objects Missing a Particular Datastream
Download Datastream Histories as XML moldybread.html#download-datastream-histories-as-xml Download Datastream Histories as XML
Download Datastream at Date moldybread.html#download-datastream-at-date Download Datastream at Date
Download All Versions of a Datastream moldybread.html#download-all-versions-of-a-datastream Download All Versions of a Datastream
Validate Checksums moldybread.html#validate-checksums Validate Checksums
Find Unique Datastreams moldybread.html#find-unique-datastreams Find Unique Datastreams
Loading

0 comments on commit 547a5b3

Please sign in to comment.