Skip to content

Commit

Permalink
0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
cosmicc committed Jan 19, 2020
1 parent 5393d3f commit 66ce3e3
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 34 deletions.
4 changes: 2 additions & 2 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
History
=======

0.1.0 (2020-01-12)
0.7.0b (2020-01-19)
------------------

* First release on PyPI.
* Pre-release
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/modules.rst
sphinx-apidoc -o docs/ rf_info
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
$(MAKE) -C docs man
$(MAKE) -C docs texinfo

servedocs: docs ## compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
Expand Down
11 changes: 1 addition & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,7 @@ Command line supports color, raw parsable, and json output

Install
-------

Python library Requires::

$ pip3 install iso3166

Command Line Requires::

$ pip3 install iso3166 colorama

Install::
::

$ pip3 install rf-info

Expand Down
17 changes: 4 additions & 13 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,11 @@ Installation
Requirements
--------------

rf-info requires the iso3166 library

.. code-block:: console
$ pip install iso3166
rf-info command line also requires the colorama library for color terminal output

.. code-block:: console
$ pip install colorama
rf-info requires the iso3166 library, and the colorama library for the command line.
These are automatically installed when rf-info is installed.


Stable release
Stable Version
--------------

To install rf-info, run this command in your terminal:
Expand All @@ -38,7 +29,7 @@ you through the process.
.. _Python installation guide: https://docs.python-guide.org/starting/installation/


From sources
Latest Version from sources
------------

The sources for rf-info can be downloaded from the `Github repo`_.
Expand Down
4 changes: 3 additions & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ To use rf-info in a python project::
>>> from rf_info import Frequency
>>> freq = Frequency('112.434.000')

then::
then::

>>> freq.details()

Returns a dictionary of all details::

>>> {'display': '144.100.000', 'hz': 144100000, 'khz': 144100.0, 'mhz': 144.1, 'ghz': 0.1441, 'wavelength': '2m', 'itu_band': 'Very High Frequency', 'itu_abbr': 'VHF', 'itu_num': 8, 'ieee_band': 'VHF', 'ieee_description': 'Very High Frequency', 'nato_band': 'A', 'waveguide_band': None, 'country_abbr': 'US', 'country_name': 'United States of America', 'amateur': True, 'fixed_station': False, 'mobile_station': False, 'broadcast': False, 'primary_allocation': ['Amateur', 'Amateur-Satellite'], 'secondary_allocation': [], 'allocation_notes': ['[5.216]: Additional allocation: in China, the band 144-146 MHz is also allocated to the aeronautical mobile (OR) service on a secondary basis.']}

You can also get each detail individually::
Expand Down
4 changes: 2 additions & 2 deletions tests/test_rf_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ def test_out_of_range():
assert str(e.value) == "Invalid Frequency Specified"

with pytest.raises(Exception) as e:
assert Frequency(freq, 'hz', 'CN')
assert Frequency('1', 'hz', 'CX')
assert str(e.value) == "Specified Country is Not Supported"

with pytest.raises(Exception) as e:
assert Frequency(freq, country='XX')
assert Frequency('1', country='XX')
assert str(e.value) == "Invalid Country Specified"


Expand Down
12 changes: 8 additions & 4 deletions tools/RELEASE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ bump2version minor (or patch, major)
git push --tags
git push

github: pull request merge
github: pull request merge to master
delete old dev branch
this will trigger travis.ci build test, if passses create release
this will trigger travis.ci build test

if tests pass

github: create a release
this will trigger travis.ci to release to pypi
github: create a release pointing to master
this will trigger travis.ci test to release to pypi

start a new dev branch

0 comments on commit 66ce3e3

Please sign in to comment.