Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FriendsOfPHP/pickle

PHP Extension installer
https://github.com/FriendsOfPHP/pickle

Last synced: 5 days ago
JSON representation

PHP Extension installer

Awesome Lists containing this project

README 

        
pickle - PHP Extension installer [![SensioLabsInsight](https://insight.sensiolabs.com/projects/7e153d04-79be-47e6-b2ee-60cdc2665dd5/small.png)](https://insight.sensiolabs.com/projects/7e153d04-79be-47e6-b2ee-60cdc2665dd5)

================================



Pickle installs PHP extensions easily on all platforms.



[![Code Climate](https://codeclimate.com/github/FriendsOfPHP/pickle.svg)](https://codeclimate.com/github/FriendsOfPHP/pickle)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/FriendsOfPHP/pickle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/FriendsOfPHP/pickle/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/FriendsOfPHP/pickle/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/FriendsOfPHP/pickle/?branch=master)

[![Build Status](https://github.com/FriendsOfPHP/pickle/workflows/Tests/badge.svg?branch=master)](https://github.com/FriendsOfPHP/pickle/actions?query=workflow%3ATests)



Installation

------------

Grab the latest phar at https://github.com/FriendsOfPHP/pickle/releases/latest 

```sh

wget https://github.com/FriendsOfPHP/pickle/releases/latest/download/pickle.phar

```



and run using

```sh

$ php pickle.phar

```

or add the execute flag

```sh

$ chmod +x pickle.phar

```

then run as:

```sh

$ pickle.phar info apcu

```

You can also rename the phar to "pickle"

```sh

$ mv pickle.phar pickle

```

so it can be called using pickle only.



And finally you can add it to your path or copy it in /usr/local/bin or your favorite binary directory.



On windows, use

```sh

$ php pickle.phar

```

or create a .bat containing:

```

@echo OFF

setlocal DISABLEDELAYEDEXPANSION

c:\path\to\php.exe "c:\path\to\pickle.phar" %*

```



If someone would be kind enough to write an installer script, we would be eternally thankful :)



Introduction

------------



Pickle is a new PHP extension installer. It is based on Composer and the plan is to get Composer to fully support it. See https://github.com/composer/composer/pull/2898#issuecomment-48439196 for the Composer part of the discussions.



Pickle fully supports existing extensions in http://pecl.php.net, running the following will install the latest available version of the memcache extension:



```sh

$ pickle install memcache

```



Windows is fully supported, to install binaries or from the sources (work in progress and given that you have a working build environment in place).



The concept behind Pickle is to ease the life of both developers and end users.



For end users, nothing changes much except that Pickle is based on modern concepts and works with multiple protocols (git or http(s) URLs).



For developers, it drastically reduces the release work. Extension meta information is not duplicated anymore. Configuration options, files to package etc. are automatically fetched from the sources and the respective files are updated during the release process. There is no risk anymore of forgetting to update the version here or there, or to neglect to include a file.



Installation From Sources

-------------------------



While the phar usage is recommended, one is indeed able to use it from git.



Clone this repository and install the dependencies with

[Composer](http://getcomposer.org/):



```sh

$ composer install

```

If you like to create your own phar from the pickle sources, you will need to install Box (http://box-project.github.io/box2/). Then clone the repository and run the following commands:



```sh

$ cd pickle

$ composer install --no-dev --optimize-autoloader

$ php -d phar.readonly=0 box.phar build

```



Usage

-----



Usage is pretty straightforward. For example, to install the memcache extension run the following command:



```sh

$ bin/pickle install memcache

```



If you need to install a specific version of an extension, you may do so:

```sh

$ bin/pickle install [email protected]

```



You can also use pickle from your extension directory, the following command:



```sh

$ cd myext

$ bin/pickle install

```



A list of the commands is available using:



```sh

$ bin/pickle list

```



To get extended help for a given command, use:



```sh

$ bin/pickle help install

```



To convert a package (based on package.xml current PECL installer), use:



```sh

$ bin/pickle convert /home/pierre/myext/

```



Or run it from the extension source directory.



Contributing

------------



Fork the project, create a feature branch and send us a pull request.



To ensure a consistent code base, you should make sure the code follows

the [PSR-1](http://www.php-fig.org/psr/psr-1/) and

[PSR-2](http://www.php-fig.org/psr/psr-2/) coding standards.



To check CS issues, you can use the `cs-check` composer command:



```sh

$ composer run cs-check

```



To automatically fix CS issues, you can use the `cs-fix` composer command:



```sh

$ composer run cs-fix

```



Support

-------



Support is available via the [issue

tracker](https://github.com/FriendsOfPHP/pickle/issues) in the Github project page

or via [IRC, EFNet, channel `#pickle`](http://chat.efnet.org/).



Running tests

-------------



You should run the tests by setting the `PICKLE_PECL_TESTSERVER` environment variable to `yes` (or `true` or `1`).

This implies that test are executed using a well-defined environment instead of using a live web server.



```sh

# On Unix-like systems

export PICKLE_PECL_TESTSERVER=yes

# On Windows systems

set PICKLE_PECL_TESTSERVER=yes

```



Unit tests are written using [atoum](https://github.com/atoum/atoum).

You will get atoum, among other dependencies, when running `composer install`.

To run tests, you will need to run the following command:



```sh

$ vendor/bin/atoum



# To run tests in a loop, ideal to do TDD

$ vendor/bin/atoum --loop

```



There are also some [Behat](https://github.com/behat/behat) tests.

You will get Behat, among other dependencies, when running `composer install`.

To run tests, you will need to run the following command:



```sh

$ vendor/bin/behat



# To choose the test suite you want to run

$ vendor/bin/behat -s pickle

```

Behat tests also test the phar, generate it prior to run the full test as described here (composer install --no-dev mode).



Pickle is covered using 4 Behat tests suites:



* `pickle` runs tests against pickle's sources

* `pickle_phar` runs tests against pickle's Phar which you have to manually

  build

* `pecl` tests PECL extensions conversion with pickle's sources

* `phar_pecl` tests PECL extensions conversion with pickle's Phar