Metadata-Version: 2.1
Name: tap-dbf
Version: 0.1.2a1
Summary: Singer tap for .DBF files
Project-URL: documentation, https://github.com/edgarrmondragon/tap-dbf#readme
Project-URL: homepage, https://github.com/edgarrmondragon/tap-dbf
Project-URL: repository, https://github.com/edgarrmondragon/tap-dbf
Author-email: "Edgar R. Mondragón" <edgarrm358@gmail.com>
Maintainer-email: "Edgar R. Mondragón" <edgarrm358@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: ELT,dBase,dbf,singer.io
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Database
Requires-Python: >=3.8
Requires-Dist: dbfread~=2.0.7
Requires-Dist: fsspec~=2023.12.2
Requires-Dist: singer-sdk~=0.34.0
Provides-Extra: dev
Requires-Dist: singer-sdk[s3,testing,typing]; extra == 'dev'
Provides-Extra: s3
Requires-Dist: s3fs~=2023.12.2; extra == 's3'
Provides-Extra: testing
Requires-Dist: deptry>=0.12; extra == 'testing'
Requires-Dist: pytest-github-actions-annotate-failures~=0.2.0; extra == 'testing'
Requires-Dist: pytest>=7.4; extra == 'testing'
Requires-Dist: singer-sdk[testing]~=0.34.0; extra == 'testing'
Provides-Extra: typing
Requires-Dist: mypy; extra == 'typing'
Requires-Dist: typing-extensions>=4.7.1; (python_version < '3.11') and extra == 'typing'
Description-Content-Type: text/markdown

# tap-dbf

Singer tap for the [dBase file format](https://en.wikipedia.org/wiki/.dbf).

## Configuration

| Key                       | Description                                                                                     | Type    | Required | Default |
|---------------------------|-------------------------------------------------------------------------------------------------|---------|----------|---------|
| `path`                    | Glob expression where the files are located. Stream names will be extracted from the file name. | string  | yes      |         |
| `ignore_missing_memofile` | Whether to proceed reading the file even if the [memofile] is not present                       | boolean | no       | false   |

### JSON example

```json
{
  "path": "tests/data/files/*.dbf",
  "ignore_missing_memofile": true
}
```

## Filesystems

### Local

Example configuration:

```json
{
  "path": "/files/*.dbf",
  "fs_root": "file://data",
  "ignore_missing_memofile": true
}
```

The `fs_root` key is optional and defaults to the current working directory:

```json
{
  "path": "data/files/*.dbf",
  "ignore_missing_memofile": true
}
```

### S3

You need to install the package with the `s3` extra:

```shell
pip install 'tap-dbf[s3]'
```

Example configuration:

```json
{
  "path": "/*.dbf",
  "fs_root": "s3://files",
  "ignore_missing_memofile": true,
  "s3": {
    "key": "someKey",
    "secret": "someSecret",
    "endpoint_url": "http://localhost:9000"
  }
}
```

## Roadmap

- Google Drive filesystem
- Dropbox filesystem

[memofile]: https://en.wikipedia.org/wiki/.dbf#Memo_fields_and_the_.DBT_file
