Merge ab700bd into 506d093

README.md

@@ -1,4 +1,4 @@
-# eido
+# <img src="docs/img/eido.svg" alt="eido logo" height="70">
 
 [![Build Status](https://travis-ci.org/pepkit/eido.svg?branch=master)](https://travis-ci.org/pepkit/eido)
 [![Coverage Status](https://coveralls.io/repos/github/pepkit/eido/badge.svg?branch=master)](https://coveralls.io/github/pepkit/eido?branch=master)

docs/README.md

@@ -1,5 +1,4 @@
-# eido
-
+<img src="img/eido.svg" alt="eido" width="200"/>
 [![Build Status](https://travis-ci.org/pepkit/eido.svg?branch=master)](https://travis-ci.org/pepkit/eido)
 [![Coverage Status](https://coveralls.io/repos/github/pepkit/eido/badge.svg?branch=master)](https://coveralls.io/github/pepkit/eido?branch=master)
 [![PEP compatible](http://pepkit.github.io/img/PEP-compatible-green.svg)](http://pepkit.github.io)
@@ -18,8 +17,8 @@ A PEP consists of metadata describing a set of items called *samples*. The metad
 
 An eido schema is written using the JSON Schema vocabulary, plus a few additional features:
 
-1. **required input files**. Eido adds `required_input_attrs`, which allows a schema author to specify which attributes must point to files that exist.
-2. **optional input files**. `input_attrs` specifies which attributes point to files that may or may not exist.
+1. **required input files**. Eido adds `requied_files`, which allows a schema author to specify which attributes must point to files that exist.
+2. **optional input files**. `files` specifies which attributes point to files that may or may not exist.
 3. **project and sample validation**. Eido validates project attributes separately from sample attributes.
 4. **schema imports**. Eido adds an `imports` section for schemas that should be validated prior to this schema
 5. **automatic multi-value support**. Eido validates successfully for singular or plural sample attributes for strings, booleans, and numbers. This accommodates the PEP subsample_table feature.

docs/autodoc_build/eido.md

@@ -72,7 +72,45 @@ Validate the config part of the Project object against a schema
 
 
 
+```python
+def read_schema(schema)
+```
+
+Safely read schema from YAML-formatted file.
+
+If the schema imports any other schemas, they will be read recursively.
+#### Parameters:
+
+- `schema` (`str | Mapping`):  path to the schema fileor schema in a dict form
+
+
+#### Returns:
+
+- `list[dict]`:  read schemas
+
+
+#### Raises:
+
+- `TypeError`:  if the schema arg is neither a Mapping nor a file path orif the 'imports' sections in any of the schemas is not a list
+
+
+
+
+```python
+def inspect_project(p, sample_names=None, max_attr=10)
+```
+
+Print inspection info: Project or, if sample_names argument is provided, matched samples
+#### Parameters:
+
+- `p` (`peppy.Project`):  project to inspect
+- `sample_names` (`Iterable[str]`):  list of samples to inspect
+- `max_attr` (`int`):  max number of sample attributes to display
+
+
+
+
 
 
 
-*Version Information: `eido` v0.0.7-dev, generated by `lucidoc` v0.4.2*
+*Version Information: `eido` v0.1.1-dev, generated by `lucidoc` v0.4.3*

docs/changelog.md

@@ -2,6 +2,11 @@
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. 
 
+## [0.1.1] - 2020-05-27
+### Changed
+- documentation updates
+- CLI behavior when no subcommand provided; [#20](https://github.com/pepkit/eido/issues/20)
+
 ## [0.1.0] - 2020-05-26
 ### Added
 - automatic support for subsamples for sample the following property types: