Commit 458f8a36 authored by xu_mijian's avatar xu_mijian
Browse files

Add a readme

parent 6d50a037
*/__pycache__/
*.egg-info
build/
dist/
\ No newline at end of file
dist/
.vscode/
\ No newline at end of file
BQMail
=================
**BQMail** is a Python module for sending mails to apply for seismic data from the IRIS DMC. It is a front-end API of the BREQ_fast.
## Installation
**BQMail** can currently run on Linux and MAC OSX. **BQMail** is running and testing on Python 3.7.
### Installation via PyPI
```
pip install bqmail
```
### Installation from source code
The latest version of the **BQMail** is available on Gitlab:
```
git clone https://git.nju.edu.cn/xumi1993/bqmail2.0.git bqmail
```
Then you can install this version:
```
cd bqmail
pip install .
```
## A quick exsample:
```Python
bq = BQMail('xxx@163.com', server='smtp.163.com', password='xxx', username='bqmail')
bq.query_events(starttime=UTCDateTime(2017, 1, 1), endtime=UTCDateTime(2018, 1, 1),
minmagnitude=5.5, catalog='GCMT')
bq.query_stations(network='CB', station='LZH')
bq.send_mail(time_before=0, time_after=1000)
```
\ No newline at end of file
......@@ -2,7 +2,7 @@
from setuptools import find_packages, setup
packages = find_packages()
VERSION = "2.0"
VERSION = "2.0.1"
setup(name='bqmail',
version=VERSION,
author='Mijian Xu',
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment