Skip to content

Commit fb00c4b

Browse files
authored
Renaming the package to be AstrodbKit (#82)
* Renaming package to be AstrodbKit * Updating readme * Updating tests * updating manifest * Updating github actions
1 parent 4043a64 commit fb00c4b

21 files changed

+94
-96
lines changed

.github/workflows/python-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ jobs:
1313
runs-on: ubuntu-latest
1414

1515
steps:
16-
- uses: actions/checkout@v3
16+
- uses: actions/checkout@v4
1717
- name: Set up Python
18-
uses: actions/setup-python@v2
18+
uses: actions/setup-python@v5
1919
with:
2020
python-version: 3.8
2121
- name: Install dependencies

.github/workflows/test-package.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
33

4-
name: Test Astrodbkit2
4+
name: Test Astrodbkit
55

66
on:
77
push:
@@ -18,9 +18,9 @@ jobs:
1818
python-version: [3.8, 3.9, '3.10', 3.11]
1919

2020
steps:
21-
- uses: actions/checkout@v3
21+
- uses: actions/checkout@v4
2222
- name: Set up Python ${{ matrix.python-version }}
23-
uses: actions/setup-python@v2
23+
uses: actions/setup-python@v5
2424
with:
2525
python-version: ${{ matrix.python-version }}
2626
- name: Install dependencies
@@ -31,9 +31,9 @@ jobs:
3131
- name: Lint with ruff
3232
run: |
3333
# stop the build if there are Python syntax errors or undefined names
34-
ruff check astrodbkit2 --select=E9,F63,F7,F82 --statistics
34+
ruff check astrodbkit --select=E9,F63,F7,F82 --statistics
3535
# exit-zero treats all errors as warnings.
36-
ruff check astrodbkit2 --config=pyproject.toml --exit-zero
36+
ruff check astrodbkit --config=pyproject.toml --exit-zero
3737
- name: Test with pytest
3838
run: |
3939
pytest --cov --cov-config=setup.cfg --cov-report=term --cov-report=xml:coverage.xml

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ include setup.cfg
44
include LICENSE.rst
55
include pyproject.toml
66

7-
recursive-include astrodbkit2 *.pyx *.c *.pxd
7+
recursive-include astrodbkit *.pyx *.c *.pxd
88
recursive-include docs *
99
recursive-include licenses *
1010
recursive-include scripts *

README.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ Astronomical database handler code
55
:target: http://www.astropy.org
66
:alt: Powered by Astropy Badge
77

8-
.. image:: https://github.com/astrodbtoolkit/AstrodbKit2/workflows/Test%20Astrodbkit2/badge.svg?branch=main
9-
:target: https://github.com/astrodbtoolkit/AstrodbKit2/actions
8+
.. image:: https://github.com/astrodbtoolkit/AstrodbKit/workflows/Test%20Astrodbkit/badge.svg?branch=main
9+
:target: https://github.com/astrodbtoolkit/AstrodbKit/actions
1010

11-
.. image:: https://codecov.io/gh/astrodbtoolkit/AstrodbKit2/graph/badge.svg?token=LMKVN65D82
12-
:target: https://codecov.io/gh/astrodbtoolkit/AstrodbKit2
11+
.. image:: https://codecov.io/gh/astrodbtoolkit/AstrodbKit/graph/badge.svg?token=LMKVN65D82
12+
:target: https://codecov.io/gh/astrodbtoolkit/AstrodbKit
1313

14-
AstrodbKit2 is an astronomical database handler code built on top of SQLAlchemy.
14+
AstrodbKit is an astronomical database handler code built on top of SQLAlchemy.
1515
This is built to work with the `SIMPLE database <https://github.com/SIMPLE-AstroDB/SIMPLE-db>`_, though
1616
similarly constructed databases will work.
1717

18-
Documentation is available at `https://astrodbkit2.readthedocs.io/en/latest/ <https://astrodbkit2.readthedocs.io/en/latest/>`_
18+
Documentation is available at `https://astrodbkit.readthedocs.io/en/latest/ <https://astrodbkit.readthedocs.io/en/latest/>`_
1919

2020
License
2121
-------
@@ -30,7 +30,7 @@ more information.
3030
Contributing
3131
------------
3232

33-
We love contributions! `AstrodbKit2 <https://astrodbkit2.readthedocs.io/en/latest/>`_ is open source,
33+
We love contributions! `AstrodbKit <https://astrodbkit.readthedocs.io/en/latest/>`_ is open source,
3434
built on open source, and we'd love to have you hang out in our community.
3535

3636
**Imposter syndrome disclaimer**: We want your help. No, really.
@@ -56,5 +56,5 @@ the errors and assumptions that seasoned contributors have glossed over.
5656
Note: This disclaimer was originally written by
5757
`Adrienne Lowe <https://github.com/adriennefriend>`_ for a
5858
`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by
59-
AstrodbKit2 based on its use in the README file for the
59+
AstrodbKit based on its use in the README file for the
6060
`MetPy project <https://github.com/Unidata/MetPy>`_.
File renamed without changes.
File renamed without changes.

astrodbkit2/schema_example.py renamed to astrodbkit/schema_example.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
from sqlalchemy import Boolean, Column, Enum, Float, ForeignKey, String
99
from sqlalchemy.orm import validates
1010

11-
from astrodbkit2.astrodb import Base
12-
from astrodbkit2.views import view
11+
from astrodbkit.astrodb import Base
12+
from astrodbkit.views import view
1313

1414

1515
# -------------------------------------------------------------------------------------------------------------------
File renamed without changes.
File renamed without changes.

astrodbkit2/tests/test_astrodb.py renamed to astrodbkit/tests/test_astrodb.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
from astropy.units.quantity import Quantity
1515
from sqlalchemy.exc import IntegrityError
1616

17-
from astrodbkit2.astrodb import Database, copy_database_schema, create_database
18-
from astrodbkit2.schema_example import *
19-
from astrodbkit2.views import view
17+
from astrodbkit.astrodb import Database, copy_database_schema, create_database
18+
from astrodbkit.schema_example import *
19+
from astrodbkit.views import view
2020

2121
try:
2222
import mock
@@ -197,7 +197,7 @@ def test_query_data(db):
197197
assert db.query(db.Sources.c.source).limit(1).all()[0][0] == '2MASS J13571237+1428398'
198198

199199

200-
@mock.patch('astrodbkit2.astrodb.get_simbad_names', return_value=['fake'])
200+
@mock.patch('astrodbkit.astrodb.get_simbad_names', return_value=['fake'])
201201
def test_search_object(mock_simbad, db):
202202
# Use the search_object method to do partial string searching
203203

@@ -310,7 +310,7 @@ def test_query_formats(db):
310310
assert isinstance(t, pd.DataFrame)
311311

312312

313-
@mock.patch('astrodbkit2.astrodb.load_spectrum')
313+
@mock.patch('astrodbkit.astrodb.load_spectrum')
314314
def test_query_spectra(mock_spectrum, db):
315315
# Test special conversions in query methods
316316
def fake_loader(x, spectra_format=None):

0 commit comments

Comments
 (0)