Skip to content

Commit

Permalink
Update package version numbers
Browse files Browse the repository at this point in the history
  • Loading branch information
ddeboer committed Aug 31, 2017
1 parent 938db77 commit 338dc40
Show file tree
Hide file tree
Showing 15 changed files with 42 additions and 28 deletions.
7 changes: 5 additions & 2 deletions docs/contributing.md
Expand Up @@ -8,10 +8,13 @@ The documentation for PortPHP is created using [MkDocs](http://www.mkdocs.org),
a lightweight solution based on Markdown.

The documentation is hosted on [Read the Docs](http://portphp.readthedocs.io).
To build the documentation on your local machine, first install the
dependencies:
To build the documentation on your local machine, clone the repository and
install the dependencies:


```bash
$ git clone https://github.com/portphp/portphp.git
$ cd portphp
$ pip install -r docs/requirements.txt
```

Expand Down
2 changes: 1 addition & 1 deletion docs/examples.md
Expand Up @@ -64,7 +64,7 @@ class Event
First make sure to include the dependencies:

```bash
$ composer require portphp/csv:1.0.x-dev portphp/doctrine:1.0.x-dev portphp/steps:1.0.x-dev
$ composer require portphp/csv portphp/doctrine portphp/steps
```

Then you can import the CSV and save it as your entity in the following way.
Expand Down
2 changes: 1 addition & 1 deletion docs/include/csv.md
@@ -1,5 +1,5 @@
Install the [CSV adapter](https://github.com/portphp/csv):

```bash
$ composer require portphp/csv:1.0.x-dev
$ composer require portphp/csv
```
2 changes: 1 addition & 1 deletion docs/include/dbal.md
@@ -1,5 +1,5 @@
Install the [DBAL adapter](https://github.com/portphp/dbal):

```bash
$ composer require portphp/dbal:1.0.x-dev
$ composer require portphp/dbal
```
2 changes: 1 addition & 1 deletion docs/include/doctrine.md
@@ -1,5 +1,5 @@
Install the Doctrine adapter:

```bash
$ composer require portphp/doctrine:1.0.x-dev
$ composer require portphp/doctrine
```
2 changes: 1 addition & 1 deletion docs/include/excel.md
@@ -1,5 +1,5 @@
Install the [Excel adapter](https://github.com/portphp/excel):

```bash
$ composer require portphp/excel:1.0.x-dev
$ composer require portphp/excel
```
2 changes: 1 addition & 1 deletion docs/include/pdo.md
@@ -1,5 +1,5 @@
Install the [PDO adapter](https://github.com/portphp/pdo):

```bash
$ composer require portphp/pdo:1.0.x-dev
$ composer require portphp/pdo
```
2 changes: 1 addition & 1 deletion docs/include/steps.md
Expand Up @@ -2,7 +2,7 @@ First install the [Steps package](https://github.com/portphp/steps), which
includes the StepAggregator:

```bash
$ composer require portphp/steps:1.0.x-dev portphp/portphp:1.0.x-dev
$ composer require portphp/steps
```

And include Composer’s autoloader in your project:
Expand Down
2 changes: 1 addition & 1 deletion docs/include/symfony-console.md
@@ -1,5 +1,5 @@
Install the [Symfony Console adapter](https://github.com/portphp/symfony-console):

```bash
$ composer require portphp/symfony-console:1.0.x-dev
$ composer require portphp/symfony-console
```
2 changes: 1 addition & 1 deletion docs/include/xml.md
@@ -1,5 +1,5 @@
Install the [XML adapter](https://github.com/portphp/xml):

```bash
$ composer require portphp/xml:1.0.x-dev
$ composer require portphp/xml
```
21 changes: 14 additions & 7 deletions docs/index.md
Expand Up @@ -24,27 +24,34 @@ $writer->finish();

## Overview

PortPHP offers a clear and simple API that abstracts from specific data sources
and targets, including Excel and CSV files, SQL and other databases, and
streams. This abstraction enables you to freely exchange data between these
media.

Broadly speaking, you can use PortPHP in two ways:

1. organize your import/export pipeline around a [workflow](workflow.md); or
2. use one or more of the components on their own, such as [readers](readers.md),
[writers](writers.md) or [converters](converters.md).




## Installation

Open a command console, enter your project directory and execute the
following command to download the latest stable version of this package:

```bash
$ composer require portphp/steps:1.0.x-dev
$ composer require portphp/steps
```

This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
This command requires you to have
[Composer installed globally](https://getcomposer.org/doc/00-intro.md).

Then include Composer’s autoloader in your project:

```php
require_once 'vendor/autoload.php';
```

## Components

Expand Down
1 change: 1 addition & 0 deletions docs/readers.md
Expand Up @@ -6,6 +6,7 @@ NoSQL databases. Additionally, you can easily
[add your own readers](#create-a-reader).

Readers are:

- iterable, for easy processing;
- optimized to use as little memory as possible, which is particularly
important in case of large datasets.
Expand Down
16 changes: 8 additions & 8 deletions docs/upgrading.md
Expand Up @@ -21,21 +21,21 @@ Readers
-------

* The `Reader::getFields()` method was removed.
* For CSV reading, you now need the port/csv package:
`$ composer require port/csv`. See the [docs](https://portphp.readthedocs.io)
* For CSV reading, you now need the CSV package:
`$ composer require portphp/csv`. See the [docs](https://portphp.readthedocs.io)
for more information.
* For Excel reading, you now need the port/excel package:
`$ composer require port/excel`. See the [docs](https://portphp.readthedocs.io)
* For Excel reading, you now need the Excel package:
`$ composer require portphp/excel`. See the [docs](https://portphp.readthedocs.io)
for more information.

Writers
-------

* For CSV reading, you now need the port/csv package:
`$ composer require port/csv`. See the [docs](https://portphp.readthedocs.io)
* For CSV writing, you now need the CSV package:
`$ composer require portphp/csv`. See the [docs](https://portphp.readthedocs.io)
for more information.
* For Excel reading, you now need the port/excel package:
`$ composer require port/excel`. See the [docs](https://portphp.readthedocs.io)
* For Excel writing, you now need the Excel package:
`$ composer require portphp/excel`. See the [docs](https://portphp.readthedocs.io)
for more information.

Converters
Expand Down
4 changes: 2 additions & 2 deletions docs/workflow.md
Expand Up @@ -4,10 +4,10 @@ The workflow streamlines your data imports/exports. Using the workflow, you can
re-usable pipelines for processing your data. Each pipeline takes place along
the following lines:

1. Construct a [reader](reader.md).
1. Construct a [reader](readers.md).
2. Construct a workflow, passing the reader to it. Optionally set a logger on
the workflow.
3. Add at least on [writer](writer.md) to the workflow. Optionally, customize
3. Add at least on [writer](writers.md) to the workflow. Optionally, customize
the workflow by adding filters, converters, mappers, etc.
4. Process the workflow. This will read data from the reader, filters and
convert the data, and write the output to each of the writers. At the end of
Expand Down
3 changes: 3 additions & 0 deletions docs/writers.md
@@ -1,5 +1,8 @@
# Writers

Writers output the data to
take the data from the [readers](readers.md)

## ArrayWriter

Resembles the [ArrayReader](#arrayreader). Probably most useful for testing
Expand Down

0 comments on commit 338dc40

Please sign in to comment.